home *** CD-ROM | disk | FTP | other *** search
/ PC World 2008 September / PCWorld_2008-09_cd.bin / domacnost a kancelar / joomla / Joomla_1.5.4-Stable-Full_Package.exe / libraries / geshi / geshi.php next >
PHP Script  |  2008-07-06  |  111KB  |  2,833 lines
  1. <?php
  2. /**
  3.  * GeSHi - Generic Syntax Highlighter
  4.  *
  5.  * The GeSHi class for Generic Syntax Highlighting. Please refer to the
  6.  * documentation at http://qbnz.com/highlighter/documentation.php for more
  7.  * information about how to use this class.
  8.  *
  9.  * For changes, release notes, TODOs etc, see the relevant files in the docs/
  10.  * directory.
  11.  *
  12.  *   This file is part of GeSHi.
  13.  *
  14.  *  GeSHi is free software; you can redistribute it and/or modify
  15.  *  it under the terms of the GNU General Public License as published by
  16.  *  the Free Software Foundation; either version 2 of the License, or
  17.  *  (at your option) any later version.
  18.  *
  19.  *  GeSHi is distributed in the hope that it will be useful,
  20.  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  21.  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22.  *  GNU General Public License for more details.
  23.  *
  24.  *  You should have received a copy of the GNU General Public License
  25.  *  along with GeSHi; if not, write to the Free Software
  26.  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  27.  *
  28.  * @package    geshi
  29.  * @subpackage core
  30.  * @author     Nigel McNie <nigel@geshi.org>
  31.  * @copyright  (C) 2004 - 2007 Nigel McNie
  32.  * @license    http://gnu.org/copyleft/gpl.html GNU GPL
  33.  *
  34.  */
  35.  
  36. //
  37. // GeSHi Constants
  38. // You should use these constant names in your programs instead of
  39. // their values - you never know when a value may change in a future
  40. // version
  41. //
  42.  
  43. /** The version of this GeSHi file */
  44. define('GESHI_VERSION', '1.0.7.19');
  45.  
  46. // Define the root directory for the GeSHi code tree
  47. if (!defined('GESHI_ROOT')) {
  48.     /** The root directory for GeSHi */
  49.     define('GESHI_ROOT', dirname(__FILE__) . DIRECTORY_SEPARATOR);
  50. }
  51. /** The language file directory for GeSHi
  52.     @access private */
  53. define('GESHI_LANG_ROOT', GESHI_ROOT . 'geshi' . DIRECTORY_SEPARATOR);
  54.  
  55.  
  56. // Line numbers - use with enable_line_numbers()
  57. /** Use no line numbers when building the result */
  58. define('GESHI_NO_LINE_NUMBERS', 0);
  59. /** Use normal line numbers when building the result */
  60. define('GESHI_NORMAL_LINE_NUMBERS', 1);
  61. /** Use fancy line numbers when building the result */
  62. define('GESHI_FANCY_LINE_NUMBERS', 2);
  63.  
  64. // Container HTML type
  65. /** Use nothing to surround the source */
  66. define('GESHI_HEADER_NONE', 0);
  67. /** Use a "div" to surround the source */
  68. define('GESHI_HEADER_DIV', 1);
  69. /** Use a "pre" to surround the source */
  70. define('GESHI_HEADER_PRE', 2);
  71.  
  72. // Capatalisation constants
  73. /** Lowercase keywords found */
  74. define('GESHI_CAPS_NO_CHANGE', 0);
  75. /** Uppercase keywords found */
  76. define('GESHI_CAPS_UPPER', 1);
  77. /** Leave keywords found as the case that they are */
  78. define('GESHI_CAPS_LOWER', 2);
  79.  
  80. // Link style constants
  81. /** Links in the source in the :link state */
  82. define('GESHI_LINK', 0);
  83. /** Links in the source in the :hover state */
  84. define('GESHI_HOVER', 1);
  85. /** Links in the source in the :active state */
  86. define('GESHI_ACTIVE', 2);
  87. /** Links in the source in the :visited state */
  88. define('GESHI_VISITED', 3);
  89.  
  90. // Important string starter/finisher
  91. // Note that if you change these, they should be as-is: i.e., don't
  92. // write them as if they had been run through htmlentities()
  93. /** The starter for important parts of the source */
  94. define('GESHI_START_IMPORTANT', '<BEGIN GeSHi>');
  95. /** The ender for important parts of the source */
  96. define('GESHI_END_IMPORTANT', '<END GeSHi>');
  97.  
  98. /**#@+
  99.  *  @access private
  100.  */
  101. // When strict mode applies for a language
  102. /** Strict mode never applies (this is the most common) */
  103. define('GESHI_NEVER', 0);
  104. /** Strict mode *might* apply, and can be enabled or
  105.     disabled by {@link GeSHi::enable_strict_mode()} */
  106. define('GESHI_MAYBE', 1);
  107. /** Strict mode always applies */
  108. define('GESHI_ALWAYS', 2);
  109.  
  110. // Advanced regexp handling constants, used in language files
  111. /** The key of the regex array defining what to search for */
  112. define('GESHI_SEARCH', 0);
  113. /** The key of the regex array defining what bracket group in a
  114.     matched search to use as a replacement */
  115. define('GESHI_REPLACE', 1);
  116. /** The key of the regex array defining any modifiers to the regular expression */
  117. define('GESHI_MODIFIERS', 2);
  118. /** The key of the regex array defining what bracket group in a
  119.     matched search to put before the replacement */
  120. define('GESHI_BEFORE', 3);
  121. /** The key of the regex array defining what bracket group in a
  122.     matched search to put after the replacement */
  123. define('GESHI_AFTER', 4);
  124. /** The key of the regex array defining a custom keyword to use
  125.     for this regexp's html tag class */
  126. define('GESHI_CLASS', 5);
  127.  
  128. /** Used in language files to mark comments */
  129. define('GESHI_COMMENTS', 0);
  130.  
  131. // Error detection - use these to analyse faults
  132. /** No sourcecode to highlight was specified
  133.  * @deprecated
  134.  */
  135. define('GESHI_ERROR_NO_INPUT', 1);
  136. /** The language specified does not exist */
  137. define('GESHI_ERROR_NO_SUCH_LANG', 2);
  138. /** GeSHi could not open a file for reading (generally a language file) */
  139. define('GESHI_ERROR_FILE_NOT_READABLE', 3);
  140. /** The header type passed to {@link GeSHi::set_header_type()} was invalid */
  141. define('GESHI_ERROR_INVALID_HEADER_TYPE', 4);
  142. /** The line number type passed to {@link GeSHi::enable_line_numbers()} was invalid */
  143. define('GESHI_ERROR_INVALID_LINE_NUMBER_TYPE', 5);
  144. /**#@-*/
  145.  
  146.  
  147. /**
  148.  * The GeSHi Class.
  149.  *
  150.  * Please refer to the documentation for GeSHi 1.0.X that is available
  151.  * at http://qbnz.com/highlighter/documentation.php for more information
  152.  * about how to use this class.
  153.  *
  154.  * @package   geshi
  155.  * @author    Nigel McNie <nigel@geshi.org>
  156.  * @copyright (C) 2004 - 2007 Nigel McNie
  157.  */
  158. class GeSHi {
  159.     /**#@+
  160.      * @access private
  161.      */
  162.     /**
  163.      * The source code to highlight
  164.      * @var string
  165.      */
  166.     var $source = '';
  167.  
  168.     /**
  169.      * The language to use when highlighting
  170.      * @var string
  171.      */
  172.     var $language = '';
  173.  
  174.     /**
  175.      * The data for the language used
  176.      * @var array
  177.      */
  178.     var $language_data = array();
  179.  
  180.     /**
  181.      * The path to the language files
  182.      * @var string
  183.      */
  184.     var $language_path = GESHI_LANG_ROOT;
  185.  
  186.     /**
  187.      * The error message associated with an error
  188.      * @var string
  189.      * @todo check err reporting works
  190.      */
  191.     var $error = false;
  192.  
  193.     /**
  194.      * Possible error messages
  195.      * @var array
  196.      */
  197.     var $error_messages = array(
  198.         GESHI_ERROR_NO_SUCH_LANG => 'GeSHi could not find the language {LANGUAGE} (using path {PATH})',
  199.         GESHI_ERROR_FILE_NOT_READABLE => 'The file specified for load_from_file was not readable',
  200.         GESHI_ERROR_INVALID_HEADER_TYPE => 'The header type specified is invalid',
  201.         GESHI_ERROR_INVALID_LINE_NUMBER_TYPE => 'The line number type specified is invalid'
  202.     );
  203.  
  204.     /**
  205.      * Whether highlighting is strict or not
  206.      * @var boolean
  207.      */
  208.     var $strict_mode = false;
  209.  
  210.     /**
  211.      * Whether to use CSS classes in output
  212.      * @var boolean
  213.      */
  214.     var $use_classes = false;
  215.  
  216.     /**
  217.      * The type of header to use. Can be one of the following
  218.      * values:
  219.      *
  220.      * - GESHI_HEADER_PRE: Source is outputted in a "pre" HTML element.
  221.      * - GESHI_HEADER_DIV: Source is outputted in a "div" HTML element.
  222.      * - GESHI_HEADER_NONE: No header is outputted.
  223.      *
  224.      * @var int
  225.      */
  226.     var $header_type = GESHI_HEADER_PRE;
  227.  
  228.     /**
  229.      * Array of permissions for which lexics should be highlighted
  230.      * @var array
  231.      */
  232.     var $lexic_permissions = array(
  233.         'KEYWORDS' =>    array(),
  234.         'COMMENTS' =>    array('MULTI' => true),
  235.         'REGEXPS' =>     array(),
  236.         'ESCAPE_CHAR' => true,
  237.         'BRACKETS' =>    true,
  238.         'SYMBOLS' =>     true,
  239.         'STRINGS' =>     true,
  240.         'NUMBERS' =>     true,
  241.         'METHODS' =>     true,
  242.         'SCRIPT' =>      true
  243.     );
  244.  
  245.     /**
  246.      * The time it took to parse the code
  247.      * @var double
  248.      */
  249.     var $time = 0;
  250.  
  251.     /**
  252.      * The content of the header block
  253.      * @var string
  254.      */
  255.     var $header_content = '';
  256.  
  257.     /**
  258.      * The content of the footer block
  259.      * @var string
  260.      */
  261.     var $footer_content = '';
  262.  
  263.     /**
  264.      * The style of the header block
  265.      * @var string
  266.      */
  267.     var $header_content_style = '';
  268.  
  269.     /**
  270.      * The style of the footer block
  271.      * @var string
  272.      */
  273.     var $footer_content_style = '';
  274.  
  275.     /**
  276.      * The styles for hyperlinks in the code
  277.      * @var array
  278.      */
  279.     var $link_styles = array();
  280.  
  281.     /**
  282.      * Whether important blocks should be recognised or not
  283.      * @var boolean
  284.      * @deprecated
  285.      * @todo REMOVE THIS FUNCTIONALITY!
  286.      */
  287.     var $enable_important_blocks = false;
  288.  
  289.     /**
  290.      * Styles for important parts of the code
  291.      * @var string
  292.      * @deprecated
  293.      * @todo As above - rethink the whole idea of important blocks as it is buggy and
  294.      * will be hard to implement in 1.2
  295.      */
  296.     var $important_styles = 'font-weight: bold; color: red;'; // Styles for important parts of the code
  297.  
  298.     /**
  299.      * Whether CSS IDs should be added to the code
  300.      * @var boolean
  301.      */
  302.     var $add_ids = false;
  303.  
  304.     /**
  305.      * Lines that should be highlighted extra
  306.      * @var array
  307.      */
  308.     var $highlight_extra_lines = array();
  309.  
  310.     /**
  311.      * Styles of extra-highlighted lines
  312.      * @var string
  313.      */
  314.     var $highlight_extra_lines_style = 'color: #cc0; background-color: #ffc;';
  315.  
  316.     /**
  317.      * Number at which line numbers should start at
  318.      * @var int
  319.      */
  320.     var $line_numbers_start = 1;
  321.  
  322.     /**
  323.      * The overall style for this code block
  324.      * @var string
  325.      */
  326.     var $overall_style = '';
  327.  
  328.     /**
  329.      *  The style for the actual code
  330.      * @var string
  331.      */
  332.     var $code_style = 'font-family: \'Courier New\', Courier, monospace; font-weight: normal;';
  333.  
  334.     /**
  335.      * The overall class for this code block
  336.      * @var string
  337.      */
  338.     var $overall_class = '';
  339.  
  340.     /**
  341.      * The overall ID for this code block
  342.      * @var string
  343.      */
  344.     var $overall_id = '';
  345.  
  346.     /**
  347.      * Line number styles
  348.      * @var string
  349.      */
  350.     var $line_style1 = 'font-family: \'Courier New\', Courier, monospace; color: black; font-weight: normal; font-style: normal;';
  351.  
  352.     /**
  353.      * Line number styles for fancy lines
  354.      * @var string
  355.      */
  356.     var $line_style2 = 'font-weight: bold;';
  357.  
  358.     /**
  359.      * Flag for how line nubmers are displayed
  360.      * @var boolean
  361.      */
  362.     var $line_numbers = GESHI_NO_LINE_NUMBERS;
  363.  
  364.     /**
  365.      * The "nth" value for fancy line highlighting
  366.      * @var int
  367.      */
  368.     var $line_nth_row = 0;
  369.  
  370.     /**
  371.      * The size of tab stops
  372.      * @var int
  373.      */
  374.     var $tab_width = 8;
  375.  
  376.     /**
  377.      * Default target for keyword links
  378.      * @var string
  379.      */
  380.     var $link_target = '';
  381.  
  382.     /**
  383.      * The encoding to use for entity encoding
  384.      * NOTE: no longer used
  385.      * @var string
  386.      */
  387.     var $encoding = 'utf-8';
  388.  
  389.     /**
  390.      * Should keywords be linked?
  391.      * @var boolean
  392.      */
  393.     var $keyword_links = true;
  394.  
  395.     /**#@-*/
  396.  
  397.     /**
  398.      * Creates a new GeSHi object, with source and language
  399.      *
  400.      * @param string The source code to highlight
  401.      * @param string The language to highlight the source with
  402.      * @param string The path to the language file directory. <b>This
  403.      *               is deprecated!</b> I've backported the auto path
  404.      *               detection from the 1.1.X dev branch, so now it
  405.      *               should be automatically set correctly. If you have
  406.      *               renamed the language directory however, you will
  407.      *               still need to set the path using this parameter or
  408.      *               {@link GeSHi::set_language_path()}
  409.      * @since 1.0.0
  410.      */
  411.     function GeSHi($source, $language, $path = '') {
  412.         $this->set_source($source);
  413.         $this->set_language_path($path);
  414.         $this->set_language($language);
  415.     }
  416.  
  417.     /**
  418.      * Returns an error message associated with the last GeSHi operation,
  419.      * or false if no error has occured
  420.      *
  421.      * @return string|false An error message if there has been an error, else false
  422.      * @since  1.0.0
  423.      */
  424.     function error() {
  425.         if ($this->error) {
  426.             $msg = $this->error_messages[$this->error];
  427.             $debug_tpl_vars = array(
  428.                 '{LANGUAGE}' => $this->language,
  429.                 '{PATH}' => $this->language_path
  430.             );
  431.             foreach ($debug_tpl_vars as $tpl => $var) {
  432.                 $msg = str_replace($tpl, $var, $msg);
  433.             }
  434.             return "<br /><strong>GeSHi Error:</strong> $msg (code $this->error)<br />";
  435.         }
  436.         return false;
  437.     }
  438.  
  439.     /**
  440.      * Gets a human-readable language name (thanks to Simon Patterson
  441.      * for the idea :))
  442.      *
  443.      * @return string The name for the current language
  444.      * @since  1.0.2
  445.      */
  446.     function get_language_name() {
  447.         if (GESHI_ERROR_NO_SUCH_LANG == $this->error) {
  448.             return $this->language_data['LANG_NAME'] . ' (Unknown Language)';
  449.         }
  450.         return $this->language_data['LANG_NAME'];
  451.     }
  452.  
  453.     /**
  454.      * Sets the source code for this object
  455.      *
  456.      * @param string The source code to highlight
  457.      * @since 1.0.0
  458.      */
  459.     function set_source($source) {
  460.         $this->source = $source;
  461.         $this->highlight_extra_lines = array();
  462.     }
  463.  
  464.     /**
  465.      * Sets the language for this object
  466.      *
  467.      * @param string The name of the language to use
  468.      * @since 1.0.0
  469.      */
  470.     function set_language($language) {
  471.         $this->error = false;
  472.         $this->strict_mode = GESHI_NEVER;
  473.  
  474.         $language = preg_replace('#[^a-zA-Z0-9\-_]#', '', $language);
  475.         $this->language = strtolower($language);
  476.  
  477.         $file_name = $this->language_path . $this->language . '.php';
  478.         if (!is_readable($file_name)) {
  479.             $this->error = GESHI_ERROR_NO_SUCH_LANG;
  480.             return;
  481.         }
  482.         // Load the language for parsing
  483.         $this->load_language($file_name);
  484.     }
  485.  
  486.     /**
  487.      * Sets the path to the directory containing the language files. Note
  488.      * that this path is relative to the directory of the script that included
  489.      * geshi.php, NOT geshi.php itself.
  490.      *
  491.      * @param string The path to the language directory
  492.      * @since 1.0.0
  493.      * @deprecated The path to the language files should now be automatically
  494.      *             detected, so this method should no longer be needed. The
  495.      *             1.1.X branch handles manual setting of the path differently
  496.      *             so this method will disappear in 1.2.0.
  497.      */
  498.     function set_language_path($path) {
  499.         if ($path) {
  500.             $this->language_path = ('/' == substr($path, strlen($path) - 1, 1)) ? $path : $path . '/';
  501.             $this->set_language($this->language);        // otherwise set_language_path has no effect
  502.         }
  503.     }
  504.  
  505.     /**
  506.      * Sets the type of header to be used.
  507.      *
  508.      * If GESHI_HEADER_DIV is used, the code is surrounded in a "div".This
  509.      * means more source code but more control over tab width and line-wrapping.
  510.      * GESHI_HEADER_PRE means that a "pre" is used - less source, but less
  511.      * control. Default is GESHI_HEADER_PRE.
  512.      *
  513.      * From 1.0.7.2, you can use GESHI_HEADER_NONE to specify that no header code
  514.      * should be outputted.
  515.      *
  516.      * @param int The type of header to be used
  517.      * @since 1.0.0
  518.      */
  519.     function set_header_type($type) {
  520.         if (GESHI_HEADER_DIV != $type && GESHI_HEADER_PRE != $type && GESHI_HEADER_NONE != $type) {
  521.             $this->error = GESHI_ERROR_INVALID_HEADER_TYPE;
  522.             return;
  523.         }
  524.         $this->header_type = $type;
  525.         // Set a default overall style if the header is a <div>
  526.         if (GESHI_HEADER_DIV == $type && !$this->overall_style) {
  527.             $this->overall_style = 'font-family: monospace;';
  528.         }
  529.     }
  530.  
  531.     /**
  532.      * Sets the styles for the code that will be outputted
  533.      * when this object is parsed. The style should be a
  534.      * string of valid stylesheet declarations
  535.      *
  536.      * @param string  The overall style for the outputted code block
  537.      * @param boolean Whether to merge the styles with the current styles or not
  538.      * @since 1.0.0
  539.      */
  540.     function set_overall_style($style, $preserve_defaults = false) {
  541.         if (!$preserve_defaults) {
  542.             $this->overall_style = $style;
  543.         }
  544.         else {
  545.             $this->overall_style .= $style;
  546.         }
  547.     }
  548.  
  549.     /**
  550.      * Sets the overall classname for this block of code. This
  551.      * class can then be used in a stylesheet to style this object's
  552.      * output
  553.      *
  554.      * @param string The class name to use for this block of code
  555.      * @since 1.0.0
  556.      */
  557.     function set_overall_class($class) {
  558.         $this->overall_class = $class;
  559.     }
  560.  
  561.     /**
  562.      * Sets the overall id for this block of code. This id can then
  563.      * be used in a stylesheet to style this object's output
  564.      *
  565.      * @param string The ID to use for this block of code
  566.      * @since 1.0.0
  567.      */
  568.     function set_overall_id($id) {
  569.         $this->overall_id = $id;
  570.     }
  571.  
  572.     /**
  573.      * Sets whether CSS classes should be used to highlight the source. Default
  574.      * is off, calling this method with no arguments will turn it on
  575.      *
  576.      * @param boolean Whether to turn classes on or not
  577.      * @since 1.0.0
  578.      */
  579.     function enable_classes($flag = true) {
  580.         $this->use_classes = ($flag) ? true : false;
  581.     }
  582.  
  583.     /**
  584.      * Sets the style for the actual code. This should be a string
  585.      * containing valid stylesheet declarations. If $preserve_defaults is
  586.      * true, then styles are merged with the default styles, with the
  587.      * user defined styles having priority
  588.      *
  589.      * Note: Use this method to override any style changes you made to
  590.      * the line numbers if you are using line numbers, else the line of
  591.      * code will have the same style as the line number! Consult the
  592.      * GeSHi documentation for more information about this.
  593.      *
  594.      * @param string  The style to use for actual code
  595.      * @param boolean Whether to merge the current styles with the new styles
  596.      */
  597.     function set_code_style($style, $preserve_defaults = false) {
  598.         if (!$preserve_defaults) {
  599.             $this->code_style = $style;
  600.         }
  601.         else {
  602.             $this->code_style .= $style;
  603.         }
  604.     }
  605.  
  606.     /**
  607.      * Sets the styles for the line numbers.
  608.      *
  609.      * @param string The style for the line numbers that are "normal"
  610.      * @param string|boolean If a string, this is the style of the line
  611.      *        numbers that are "fancy", otherwise if boolean then this
  612.      *        defines whether the normal styles should be merged with the
  613.      *        new normal styles or not
  614.      * @param boolean If set, is the flag for whether to merge the "fancy"
  615.      *        styles with the current styles or not
  616.      * @since 1.0.2
  617.      */
  618.     function set_line_style($style1, $style2 = '', $preserve_defaults = false) {
  619.         if (is_bool($style2)) {
  620.             $preserve_defaults = $style2;
  621.             $style2 = '';
  622.         }
  623.         if (!$preserve_defaults) {
  624.             $this->line_style1 = $style1;
  625.             $this->line_style2 = $style2;
  626.         }
  627.         else {
  628.             $this->line_style1 .= $style1;
  629.             $this->line_style2 .= $style2;
  630.         }
  631.     }
  632.  
  633.     /**
  634.      * Sets whether line numbers should be displayed.
  635.      *
  636.      * Valid values for the first parameter are:
  637.      *
  638.      *  - GESHI_NO_LINE_NUMBERS: Line numbers will not be displayed
  639.      *  - GESHI_NORMAL_LINE_NUMBERS: Line numbers will be displayed
  640.      *  - GESHI_FANCY_LINE_NUMBERS: Fancy line numbers will be displayed
  641.      *
  642.      * For fancy line numbers, the second parameter is used to signal which lines
  643.      * are to be fancy. For example, if the value of this parameter is 5 then every
  644.      * 5th line will be fancy.
  645.      *
  646.      * @param int How line numbers should be displayed
  647.      * @param int Defines which lines are fancy
  648.      * @since 1.0.0
  649.      */
  650.     function enable_line_numbers($flag, $nth_row = 5) {
  651.         if (GESHI_NO_LINE_NUMBERS != $flag && GESHI_NORMAL_LINE_NUMBERS != $flag
  652.             && GESHI_FANCY_LINE_NUMBERS != $flag) {
  653.             $this->error = GESHI_ERROR_INVALID_LINE_NUMBER_TYPE;
  654.         }
  655.         $this->line_numbers = $flag;
  656.         $this->line_nth_row = $nth_row;
  657.     }
  658.  
  659.     /**
  660.      * Sets the style for a keyword group. If $preserve_defaults is
  661.      * true, then styles are merged with the default styles, with the
  662.      * user defined styles having priority
  663.      *
  664.      * @param int     The key of the keyword group to change the styles of
  665.      * @param string  The style to make the keywords
  666.      * @param boolean Whether to merge the new styles with the old or just
  667.      *                to overwrite them
  668.      * @since 1.0.0
  669.      */
  670.     function set_keyword_group_style($key, $style, $preserve_defaults = false) {
  671.         if (!$preserve_defaults) {
  672.             $this->language_data['STYLES']['KEYWORDS'][$key] = $style;
  673.         }
  674.         else {
  675.             $this->language_data['STYLES']['KEYWORDS'][$key] .= $style;
  676.         }
  677.     }
  678.  
  679.     /**
  680.      * Turns highlighting on/off for a keyword group
  681.      *
  682.      * @param int     The key of the keyword group to turn on or off
  683.      * @param boolean Whether to turn highlighting for that group on or off
  684.      * @since 1.0.0
  685.      */
  686.     function set_keyword_group_highlighting($key, $flag = true) {
  687.         $this->lexic_permissions['KEYWORDS'][$key] = ($flag) ? true : false;
  688.     }
  689.  
  690.     /**
  691.      * Sets the styles for comment groups.  If $preserve_defaults is
  692.      * true, then styles are merged with the default styles, with the
  693.      * user defined styles having priority
  694.      *
  695.      * @param int     The key of the comment group to change the styles of
  696.      * @param string  The style to make the comments
  697.      * @param boolean Whether to merge the new styles with the old or just
  698.      *                to overwrite them
  699.      * @since 1.0.0
  700.      */
  701.     function set_comments_style($key, $style, $preserve_defaults = false) {
  702.         if (!$preserve_defaults) {
  703.             $this->language_data['STYLES']['COMMENTS'][$key] = $style;
  704.         }
  705.         else {
  706.             $this->language_data['STYLES']['COMMENTS'][$key] .= $style;
  707.         }
  708.     }
  709.  
  710.     /**
  711.      * Turns highlighting on/off for comment groups
  712.      *
  713.      * @param int     The key of the comment group to turn on or off
  714.      * @param boolean Whether to turn highlighting for that group on or off
  715.      * @since 1.0.0
  716.      */
  717.     function set_comments_highlighting($key, $flag = true) {
  718.         $this->lexic_permissions['COMMENTS'][$key] = ($flag) ? true : false;
  719.     }
  720.  
  721.     /**
  722.      * Sets the styles for escaped characters. If $preserve_defaults is
  723.      * true, then styles are merged with the default styles, with the
  724.      * user defined styles having priority
  725.      *
  726.      * @param string  The style to make the escape characters
  727.      * @param boolean Whether to merge the new styles with the old or just
  728.      *                to overwrite them
  729.      * @since 1.0.0
  730.      */
  731.     function set_escape_characters_style($style, $preserve_defaults = false) {
  732.         if (!$preserve_defaults) {
  733.             $this->language_data['STYLES']['ESCAPE_CHAR'][0] = $style;
  734.         }
  735.         else {
  736.             $this->language_data['STYLES']['ESCAPE_CHAR'][0] .= $style;
  737.         }
  738.     }
  739.  
  740.     /**
  741.      * Turns highlighting on/off for escaped characters
  742.      *
  743.      * @param boolean Whether to turn highlighting for escape characters on or off
  744.      * @since 1.0.0
  745.      */
  746.     function set_escape_characters_highlighting($flag = true) {
  747.         $this->lexic_permissions['ESCAPE_CHAR'] = ($flag) ? true : false;
  748.     }
  749.  
  750.     /**
  751.      * Sets the styles for brackets. If $preserve_defaults is
  752.      * true, then styles are merged with the default styles, with the
  753.      * user defined styles having priority
  754.      *
  755.      * This method is DEPRECATED: use set_symbols_style instead.
  756.      * This method will be removed in 1.2.X
  757.      *
  758.      * @param string  The style to make the brackets
  759.      * @param boolean Whether to merge the new styles with the old or just
  760.      *                to overwrite them
  761.      * @since 1.0.0
  762.      * @deprecated In favour of set_symbols_style
  763.      */
  764.     function set_brackets_style($style, $preserve_defaults = false) {
  765.         if (!$preserve_defaults) {
  766.             $this->language_data['STYLES']['BRACKETS'][0] = $style;
  767.         }
  768.         else {
  769.             $this->language_data['STYLES']['BRACKETS'][0] .= $style;
  770.         }
  771.     }
  772.  
  773.     /**
  774.      * Turns highlighting on/off for brackets
  775.      *
  776.      * This method is DEPRECATED: use set_symbols_highlighting instead.
  777.      * This method will be remove in 1.2.X
  778.      *
  779.      * @param boolean Whether to turn highlighting for brackets on or off
  780.      * @since 1.0.0
  781.      * @deprecated In favour of set_symbols_highlighting
  782.      */
  783.     function set_brackets_highlighting($flag) {
  784.         $this->lexic_permissions['BRACKETS'] = ($flag) ? true : false;
  785.     }
  786.  
  787.     /**
  788.      * Sets the styles for symbols. If $preserve_defaults is
  789.      * true, then styles are merged with the default styles, with the
  790.      * user defined styles having priority
  791.      *
  792.      * @param string  The style to make the symbols
  793.      * @param boolean Whether to merge the new styles with the old or just
  794.      *                to overwrite them
  795.      * @since 1.0.1
  796.      */
  797.     function set_symbols_style($style, $preserve_defaults = false) {
  798.         if (!$preserve_defaults) {
  799.             $this->language_data['STYLES']['SYMBOLS'][0] = $style;
  800.         }
  801.         else {
  802.             $this->language_data['STYLES']['SYMBOLS'][0] .= $style;
  803.         }
  804.         // For backward compatibility
  805.         $this->set_brackets_style ($style, $preserve_defaults);
  806.     }
  807.  
  808.     /**
  809.      * Turns highlighting on/off for symbols
  810.      *
  811.      * @param boolean Whether to turn highlighting for symbols on or off
  812.      * @since 1.0.0
  813.      */
  814.     function set_symbols_highlighting($flag) {
  815.         $this->lexic_permissions['SYMBOLS'] = ($flag) ? true : false;
  816.         // For backward compatibility
  817.         $this->set_brackets_highlighting ($flag);
  818.     }
  819.  
  820.     /**
  821.      * Sets the styles for strings. If $preserve_defaults is
  822.      * true, then styles are merged with the default styles, with the
  823.      * user defined styles having priority
  824.      *
  825.      * @param string  The style to make the escape characters
  826.      * @param boolean Whether to merge the new styles with the old or just
  827.      *                to overwrite them
  828.      * @since 1.0.0
  829.      */
  830.     function set_strings_style($style, $preserve_defaults = false) {
  831.         if (!$preserve_defaults) {
  832.             $this->language_data['STYLES']['STRINGS'][0] = $style;
  833.         }
  834.         else {
  835.             $this->language_data['STYLES']['STRINGS'][0] .= $style;
  836.         }
  837.     }
  838.  
  839.     /**
  840.      * Turns highlighting on/off for strings
  841.      *
  842.      * @param boolean Whether to turn highlighting for strings on or off
  843.      * @since 1.0.0
  844.      */
  845.     function set_strings_highlighting($flag) {
  846.         $this->lexic_permissions['STRINGS'] = ($flag) ? true : false;
  847.     }
  848.  
  849.     /**
  850.      * Sets the styles for numbers. If $preserve_defaults is
  851.      * true, then styles are merged with the default styles, with the
  852.      * user defined styles having priority
  853.      *
  854.      * @param string  The style to make the numbers
  855.      * @param boolean Whether to merge the new styles with the old or just
  856.      *                to overwrite them
  857.      * @since 1.0.0
  858.      */
  859.     function set_numbers_style($style, $preserve_defaults = false) {
  860.         if (!$preserve_defaults) {
  861.             $this->language_data['STYLES']['NUMBERS'][0] = $style;
  862.         }
  863.         else {
  864.             $this->language_data['STYLES']['NUMBERS'][0] .= $style;
  865.         }
  866.     }
  867.  
  868.     /**
  869.      * Turns highlighting on/off for numbers
  870.      *
  871.      * @param boolean Whether to turn highlighting for numbers on or off
  872.      * @since 1.0.0
  873.      */
  874.     function set_numbers_highlighting($flag) {
  875.         $this->lexic_permissions['NUMBERS'] = ($flag) ? true : false;
  876.     }
  877.  
  878.     /**
  879.      * Sets the styles for methods. $key is a number that references the
  880.      * appropriate "object splitter" - see the language file for the language
  881.      * you are highlighting to get this number. If $preserve_defaults is
  882.      * true, then styles are merged with the default styles, with the
  883.      * user defined styles having priority
  884.      *
  885.      * @param int     The key of the object splitter to change the styles of
  886.      * @param string  The style to make the methods
  887.      * @param boolean Whether to merge the new styles with the old or just
  888.      *                to overwrite them
  889.      * @since 1.0.0
  890.      */
  891.     function set_methods_style($key, $style, $preserve_defaults = false) {
  892.         if (!$preserve_defaults) {
  893.             $this->language_data['STYLES']['METHODS'][$key] = $style;
  894.         }
  895.         else {
  896.             $this->language_data['STYLES']['METHODS'][$key] .= $style;
  897.         }
  898.     }
  899.  
  900.     /**
  901.      * Turns highlighting on/off for methods
  902.      *
  903.      * @param boolean Whether to turn highlighting for methods on or off
  904.      * @since 1.0.0
  905.      */
  906.     function set_methods_highlighting($flag) {
  907.         $this->lexic_permissions['METHODS'] = ($flag) ? true : false;
  908.     }
  909.  
  910.     /**
  911.      * Sets the styles for regexps. If $preserve_defaults is
  912.      * true, then styles are merged with the default styles, with the
  913.      * user defined styles having priority
  914.      *
  915.      * @param string  The style to make the regular expression matches
  916.      * @param boolean Whether to merge the new styles with the old or just
  917.      *                to overwrite them
  918.      * @since 1.0.0
  919.      */
  920.     function set_regexps_style($key, $style, $preserve_defaults = false) {
  921.         if (!$preserve_defaults) {
  922.             $this->language_data['STYLES']['REGEXPS'][$key] = $style;
  923.         }
  924.         else {
  925.             $this->language_data['STYLES']['REGEXPS'][$key] .= $style;
  926.         }
  927.     }
  928.  
  929.     /**
  930.      * Turns highlighting on/off for regexps
  931.      *
  932.      * @param int     The key of the regular expression group to turn on or off
  933.      * @param boolean Whether to turn highlighting for the regular expression group on or off
  934.      * @since 1.0.0
  935.      */
  936.     function set_regexps_highlighting($key, $flag) {
  937.         $this->lexic_permissions['REGEXPS'][$key] = ($flag) ? true : false;
  938.     }
  939.  
  940.     /**
  941.      * Sets whether a set of keywords are checked for in a case sensitive manner
  942.      *
  943.      * @param int The key of the keyword group to change the case sensitivity of
  944.      * @param boolean Whether to check in a case sensitive manner or not
  945.      * @since 1.0.0
  946.      */
  947.     function set_case_sensitivity($key, $case) {
  948.         $this->language_data['CASE_SENSITIVE'][$key] = ($case) ? true : false;
  949.     }
  950.  
  951.     /**
  952.      * Sets the case that keywords should use when found. Use the constants:
  953.      *
  954.      *  - GESHI_CAPS_NO_CHANGE: leave keywords as-is
  955.      *  - GESHI_CAPS_UPPER: convert all keywords to uppercase where found
  956.      *  - GESHI_CAPS_LOWER: convert all keywords to lowercase where found
  957.      *
  958.      * @param int A constant specifying what to do with matched keywords
  959.      * @since 1.0.1
  960.      * @todo  Error check the passed value
  961.      */
  962.     function set_case_keywords($case) {
  963.         $this->language_data['CASE_KEYWORDS'] = $case;
  964.     }
  965.  
  966.     /**
  967.      * Sets how many spaces a tab is substituted for
  968.      *
  969.      * Widths below zero are ignored
  970.      *
  971.      * @param int The tab width
  972.      * @since 1.0.0
  973.      */
  974.     function set_tab_width($width) {
  975.         $this->tab_width = intval($width);
  976.     }
  977.  
  978.     /**
  979.      * Enables/disables strict highlighting. Default is off, calling this
  980.      * method without parameters will turn it on. See documentation
  981.      * for more details on strict mode and where to use it.
  982.      *
  983.      * @param boolean Whether to enable strict mode or not
  984.      * @since 1.0.0
  985.      */
  986.     function enable_strict_mode($mode = true) {
  987.         if (GESHI_MAYBE == $this->language_data['STRICT_MODE_APPLIES']) {
  988.           $this->strict_mode = ($mode) ? true : false;
  989.         }
  990.     }
  991.  
  992.     /**
  993.      * Disables all highlighting
  994.      *
  995.      * @since 1.0.0
  996.      * @todo Rewrite with an array traversal
  997.      */
  998.     function disable_highlighting() {
  999.         foreach ($this->lexic_permissions as $key => $value) {
  1000.             if (is_array($value)) {
  1001.                 foreach ($value as $k => $v) {
  1002.                     $this->lexic_permissions[$key][$k] = false;
  1003.                 }
  1004.             }
  1005.             else {
  1006.                 $this->lexic_permissions[$key] = false;
  1007.             }
  1008.         }
  1009.         // Context blocks
  1010.         $this->enable_important_blocks = false;
  1011.     }
  1012.  
  1013.     /**
  1014.      * Enables all highlighting
  1015.      *
  1016.      * @since 1.0.0
  1017.      * @todo  Rewrite with array traversal
  1018.      */
  1019.     function enable_highlighting() {
  1020.         foreach ($this->lexic_permissions as $key => $value) {
  1021.             if (is_array($value)) {
  1022.                 foreach ($value as $k => $v) {
  1023.                     $this->lexic_permissions[$key][$k] = true;
  1024.                 }
  1025.             }
  1026.             else {
  1027.                 $this->lexic_permissions[$key] = true;
  1028.             }
  1029.         }
  1030.         // Context blocks
  1031.         $this->enable_important_blocks = true;
  1032.     }
  1033.  
  1034.     /**
  1035.      * Given a file extension, this method returns either a valid geshi language
  1036.      * name, or the empty string if it couldn't be found
  1037.      *
  1038.      * @param string The extension to get a language name for
  1039.      * @param array  A lookup array to use instead of the default
  1040.      * @since 1.0.5
  1041.      * @todo Re-think about how this method works (maybe make it private and/or make it
  1042.      *       a extension->lang lookup?)
  1043.      * @todo static?
  1044.      */
  1045.     function get_language_name_from_extension( $extension, $lookup = array() ) {
  1046.         if ( !$lookup ) {
  1047.             $lookup = array(
  1048.                 'actionscript' => array('as'),
  1049.                 'ada' => array('a', 'ada', 'adb', 'ads'),
  1050.                 'apache' => array('conf'),
  1051.                 'asm' => array('ash', 'asm'),
  1052.                 'asp' => array('asp'),
  1053.                 'bash' => array('sh'),
  1054.                 'c' => array('c', 'h'),
  1055.                 'c_mac' => array('c', 'h'),
  1056.                 'caddcl' => array(),
  1057.                 'cadlisp' => array(),
  1058.                 'cdfg' => array('cdfg'),
  1059.                 'cpp' => array('cpp', 'h', 'hpp'),
  1060.                 'csharp' => array(),
  1061.                 'css' => array('css'),
  1062.                 'delphi' => array('dpk', 'dpr'),
  1063.                 'html4strict' => array('html', 'htm'),
  1064.                 'java' => array('java'),
  1065.                 'javascript' => array('js'),
  1066.                 'lisp' => array('lisp'),
  1067.                 'lua' => array('lua'),
  1068.                 'mpasm' => array(),
  1069.                 'nsis' => array(),
  1070.                 'objc' => array(),
  1071.                 'oobas' => array(),
  1072.                 'oracle8' => array(),
  1073.                 'pascal' => array('pas'),
  1074.                 'perl' => array('pl', 'pm'),
  1075.                 'php' => array('php', 'php5', 'phtml', 'phps'),
  1076.                 'python' => array('py'),
  1077.                 'qbasic' => array('bi'),
  1078.                 'sas' => array('sas'),
  1079.                 'smarty' => array(),
  1080.                 'vb' => array('bas'),
  1081.                 'vbnet' => array(),
  1082.                 'visualfoxpro' => array(),
  1083.                 'xml' => array('xml')
  1084.             );
  1085.         }
  1086.  
  1087.         foreach ($lookup as $lang => $extensions) {
  1088.             foreach ($extensions as $ext) {
  1089.                 if ($ext == $extension) {
  1090.                     return $lang;
  1091.                 }
  1092.             }
  1093.         }
  1094.         return '';
  1095.     }
  1096.  
  1097.     /**
  1098.      * Given a file name, this method loads its contents in, and attempts
  1099.      * to set the language automatically. An optional lookup table can be
  1100.      * passed for looking up the language name. If not specified a default
  1101.      * table is used
  1102.      *
  1103.      * The language table is in the form
  1104.      * <pre>array(
  1105.      *   'lang_name' => array('extension', 'extension', ...),
  1106.      *   'lang_name' ...
  1107.      * );</pre>
  1108.      *
  1109.      * @todo Complete rethink of this and above method
  1110.      * @since 1.0.5
  1111.      */
  1112.     function load_from_file($file_name, $lookup = array()) {
  1113.         if (is_readable($file_name)) {
  1114.             $this->set_source(implode('', file($file_name)));
  1115.             $this->set_language($this->get_language_name_from_extension(substr(strrchr($file_name, '.'), 1), $lookup));
  1116.         }
  1117.         else {
  1118.             $this->error = GESHI_ERROR_FILE_NOT_READABLE;
  1119.         }
  1120.     }
  1121.  
  1122.     /**
  1123.      * Adds a keyword to a keyword group for highlighting
  1124.      *
  1125.      * @param int    The key of the keyword group to add the keyword to
  1126.      * @param string The word to add to the keyword group
  1127.      * @since 1.0.0
  1128.      */
  1129.     function add_keyword($key, $word) {
  1130.         $this->language_data['KEYWORDS'][$key][] = $word;
  1131.     }
  1132.  
  1133.     /**
  1134.      * Removes a keyword from a keyword group
  1135.      *
  1136.      * @param int    The key of the keyword group to remove the keyword from
  1137.      * @param string The word to remove from the keyword group
  1138.      * @since 1.0.0
  1139.      */
  1140.     function remove_keyword($key, $word) {
  1141.         $this->language_data['KEYWORDS'][$key] =
  1142.             array_diff($this->language_data['KEYWORDS'][$key], array($word));
  1143.     }
  1144.  
  1145.     /**
  1146.      * Creates a new keyword group
  1147.      *
  1148.      * @param int    The key of the keyword group to create
  1149.      * @param string The styles for the keyword group
  1150.      * @param boolean Whether the keyword group is case sensitive ornot
  1151.      * @param array  The words to use for the keyword group
  1152.      * @since 1.0.0
  1153.      */
  1154.     function add_keyword_group($key, $styles, $case_sensitive = true, $words = array()) {
  1155.         $words = (array) $words;
  1156.         $this->language_data['KEYWORDS'][$key] = $words;
  1157.         $this->lexic_permissions['KEYWORDS'][$key] = true;
  1158.         $this->language_data['CASE_SENSITIVE'][$key] = $case_sensitive;
  1159.         $this->language_data['STYLES']['KEYWORDS'][$key] = $styles;
  1160.     }
  1161.  
  1162.     /**
  1163.      * Removes a keyword group
  1164.      *
  1165.      * @param int    The key of the keyword group to remove
  1166.      * @since 1.0.0
  1167.      */
  1168.     function remove_keyword_group ($key) {
  1169.         unset($this->language_data['KEYWORDS'][$key]);
  1170.         unset($this->lexic_permissions['KEYWORDS'][$key]);
  1171.         unset($this->language_data['CASE_SENSITIVE'][$key]);
  1172.         unset($this->language_data['STYLES']['KEYWORDS'][$key]);
  1173.     }
  1174.  
  1175.     /**
  1176.      * Sets the content of the header block
  1177.      *
  1178.      * @param string The content of the header block
  1179.      * @since 1.0.2
  1180.      */
  1181.     function set_header_content($content) {
  1182.         $this->header_content = $content;
  1183.     }
  1184.  
  1185.     /**
  1186.      * Sets the content of the footer block
  1187.      *
  1188.      * @param string The content of the footer block
  1189.      * @since 1.0.2
  1190.      */
  1191.     function set_footer_content($content) {
  1192.         $this->footer_content = $content;
  1193.     }
  1194.  
  1195.     /**
  1196.      * Sets the style for the header content
  1197.      *
  1198.      * @param string The style for the header content
  1199.      * @since 1.0.2
  1200.      */
  1201.     function set_header_content_style($style) {
  1202.         $this->header_content_style = $style;
  1203.     }
  1204.  
  1205.     /**
  1206.      * Sets the style for the footer content
  1207.      *
  1208.      * @param string The style for the footer content
  1209.      * @since 1.0.2
  1210.      */
  1211.     function set_footer_content_style($style) {
  1212.         $this->footer_content_style = $style;
  1213.     }
  1214.  
  1215.     /**
  1216.      * Sets the base URL to be used for keywords
  1217.      *
  1218.      * @param int The key of the keyword group to set the URL for
  1219.      * @param string The URL to set for the group. If {FNAME} is in
  1220.      *               the url somewhere, it is replaced by the keyword
  1221.      *               that the URL is being made for
  1222.      * @since 1.0.2
  1223.      */
  1224.     function set_url_for_keyword_group($group, $url) {
  1225.         $this->language_data['URLS'][$group] = $url;
  1226.     }
  1227.  
  1228.     /**
  1229.      * Sets styles for links in code
  1230.      *
  1231.      * @param int A constant that specifies what state the style is being
  1232.      *            set for - e.g. :hover or :visited
  1233.      * @param string The styles to use for that state
  1234.      * @since 1.0.2
  1235.      */
  1236.     function set_link_styles($type, $styles) {
  1237.         $this->link_styles[$type] = $styles;
  1238.     }
  1239.  
  1240.     /**
  1241.      * Sets the target for links in code
  1242.      *
  1243.      * @param string The target for links in the code, e.g. _blank
  1244.      * @since 1.0.3
  1245.      */
  1246.     function set_link_target($target) {
  1247.         if (!$target) {
  1248.             $this->link_target = '';
  1249.         }
  1250.         else {
  1251.             $this->link_target = ' target="' . $target . '" ';
  1252.         }
  1253.     }
  1254.  
  1255.     /**
  1256.      * Sets styles for important parts of the code
  1257.      *
  1258.      * @param string The styles to use on important parts of the code
  1259.      * @since 1.0.2
  1260.      */
  1261.     function set_important_styles($styles) {
  1262.         $this->important_styles = $styles;
  1263.     }
  1264.  
  1265.     /**
  1266.      * Sets whether context-important blocks are highlighted
  1267.      *
  1268.      * @todo REMOVE THIS SHIZ FROM GESHI!
  1269.      * @deprecated
  1270.      */
  1271.     function enable_important_blocks($flag) {
  1272.         $this->enable_important_blocks = ( $flag ) ? true : false;
  1273.     }
  1274.  
  1275.     /**
  1276.      * Whether CSS IDs should be added to each line
  1277.      *
  1278.      * @param boolean If true, IDs will be added to each line.
  1279.      * @since 1.0.2
  1280.      */
  1281.     function enable_ids($flag = true) {
  1282.         $this->add_ids = ($flag) ? true : false;
  1283.     }
  1284.  
  1285.     /**
  1286.      * Specifies which lines to highlight extra
  1287.      *
  1288.      * @param mixed An array of line numbers to highlight, or just a line
  1289.      *              number on its own.
  1290.      * @since 1.0.2
  1291.      * @todo  Some data replication here that could be cut down on
  1292.      */
  1293.     function highlight_lines_extra($lines) {
  1294.         if (is_array($lines)) {
  1295.             foreach ($lines as $line) {
  1296.                 $this->highlight_extra_lines[intval($line)] = intval($line);
  1297.             }
  1298.         }
  1299.         else {
  1300.             $this->highlight_extra_lines[intval($lines)] = intval($lines);
  1301.         }
  1302.     }
  1303.  
  1304.     /**
  1305.      * Sets the style for extra-highlighted lines
  1306.      *
  1307.      * @param string The style for extra-highlighted lines
  1308.      * @since 1.0.2
  1309.      */
  1310.     function set_highlight_lines_extra_style($styles) {
  1311.         $this->highlight_extra_lines_style = $styles;
  1312.     }
  1313.  
  1314.     /**
  1315.      * Sets what number line numbers should start at. Should
  1316.      * be a positive integer, and will be converted to one.
  1317.      *
  1318.      * <b>Warning:</b> Using this method will add the "start"
  1319.      * attribute to the <ol> that is used for line numbering.
  1320.      * This is <b>not</b> valid XHTML strict, so if that's what you
  1321.      * care about then don't use this method. Firefox is getting
  1322.      * support for the CSS method of doing this in 1.1 and Opera
  1323.      * has support for the CSS method, but (of course) IE doesn't
  1324.      * so it's not worth doing it the CSS way yet.
  1325.      *
  1326.      * @param int The number to start line numbers at
  1327.      * @since 1.0.2
  1328.      */
  1329.     function start_line_numbers_at($number) {
  1330.         $this->line_numbers_start = abs(intval($number));
  1331.     }
  1332.  
  1333.     /**
  1334.      * Sets the encoding used for htmlspecialchars(), for international
  1335.      * support.
  1336.      *
  1337.      * NOTE: This is not needed for now because htmlspecialchars() is not
  1338.      * being used (it has a security hole in PHP4 that has not been patched).
  1339.      * Maybe in a future version it may make a return for speed reasons, but
  1340.      * I doubt it.
  1341.      *
  1342.      * @param string The encoding to use for the source
  1343.      * @since 1.0.3
  1344.      */
  1345.     function set_encoding($encoding) {
  1346.         if ($encoding) {
  1347.           $this->encoding = $encoding;
  1348.         }
  1349.     }
  1350.  
  1351.     /**
  1352.      * Turns linking of keywords on or off.
  1353.      *
  1354.      * @param boolean If true, links will be added to keywords
  1355.      */
  1356.     function enable_keyword_links($enable = true) {
  1357.         $this->keyword_links = ($enable) ? true : false;
  1358.     }
  1359.  
  1360.     /**
  1361.      * Returns the code in $this->source, highlighted and surrounded by the
  1362.      * nessecary HTML.
  1363.      *
  1364.      * This should only be called ONCE, cos it's SLOW! If you want to highlight
  1365.      * the same source multiple times, you're better off doing a whole lot of
  1366.      * str_replaces to replace the <span>s
  1367.      *
  1368.      * @since 1.0.0
  1369.      */
  1370.     function parse_code () {
  1371.         // Start the timer
  1372.         $start_time = microtime();
  1373.  
  1374.         // Firstly, if there is an error, we won't highlight
  1375.         if ($this->error) {
  1376.             $result = GeSHi::hsc($this->source);
  1377.             // Timing is irrelevant
  1378.             $this->set_time($start_time, $start_time);
  1379.             return $this->finalise($result);
  1380.         }
  1381.  
  1382.         // Replace all newlines to a common form.
  1383.         $code = str_replace("\r\n", "\n", $this->source);
  1384.         $code = str_replace("\r", "\n", $code);
  1385.         // Add spaces for regular expression matching and line numbers
  1386.         $code = "\n" . $code . "\n";
  1387.  
  1388.         // Initialise various stuff
  1389.         $length           = strlen($code);
  1390.         $STRING_OPEN      = '';
  1391.         $CLOSE_STRING     = false;
  1392.         $ESCAPE_CHAR_OPEN = false;
  1393.         $COMMENT_MATCHED  = false;
  1394.         // Turn highlighting on if strict mode doesn't apply to this language
  1395.         $HIGHLIGHTING_ON  = ( !$this->strict_mode ) ? true : '';
  1396.         // Whether to highlight inside a block of code
  1397.         $HIGHLIGHT_INSIDE_STRICT = false;
  1398.         $HARDQUOTE_OPEN = false;
  1399.         $STRICTATTRS = '';
  1400.         $stuff_to_parse   = '';
  1401.         $result           = '';
  1402.  
  1403.         // "Important" selections are handled like multiline comments
  1404.         // @todo GET RID OF THIS SHIZ
  1405.         if ($this->enable_important_blocks) {
  1406.             $this->language_data['COMMENT_MULTI'][GESHI_START_IMPORTANT] = GESHI_END_IMPORTANT;
  1407.         }
  1408.  
  1409.         if ($this->strict_mode) {
  1410.             // Break the source into bits. Each bit will be a portion of the code
  1411.             // within script delimiters - for example, HTML between < and >
  1412.             $parts = array(0 => array(0 => ''));
  1413.             $k = 0;
  1414.             for ($i = 0; $i < $length; $i++) {
  1415.                 $char = substr($code, $i, 1);
  1416.                 if (!$HIGHLIGHTING_ON) {
  1417.                     foreach ($this->language_data['SCRIPT_DELIMITERS'] as $key => $delimiters) {
  1418.                         foreach ($delimiters as $open => $close) {
  1419.                             // Get the next little bit for this opening string
  1420.                             $check = substr($code, $i, strlen($open));
  1421.                             // If it matches...
  1422.                             if ($check == $open) {
  1423.                                 // We start a new block with the highlightable
  1424.                                 // code in it
  1425.                                 $HIGHLIGHTING_ON = $open;
  1426.                                 $i += strlen($open) - 1;
  1427.                                 $char = $open;
  1428.                                 $parts[++$k][0] = $char;
  1429.  
  1430.                                 // No point going around again...
  1431.                                 break(2);
  1432.                             }
  1433.                         }
  1434.                     }
  1435.                 }
  1436.                 else {
  1437.                     foreach ($this->language_data['SCRIPT_DELIMITERS'] as $key => $delimiters) {
  1438.                         foreach ($delimiters as $open => $close) {
  1439.                             if ($open == $HIGHLIGHTING_ON) {
  1440.                                 // Found the closing tag
  1441.                                 break(2);
  1442.                             }
  1443.                         }
  1444.                     }
  1445.                     // We check code from our current position BACKWARDS. This is so
  1446.                     // the ending string for highlighting can be included in the block
  1447.                     $check = substr($code, $i - strlen($close) + 1, strlen($close));
  1448.                     if ($check == $close) {
  1449.                         $HIGHLIGHTING_ON = '';
  1450.                         // Add the string to the rest of the string for this part
  1451.                         $parts[$k][1] = ( isset($parts[$k][1]) ) ? $parts[$k][1] . $char : $char;
  1452.                         $parts[++$k][0] = '';
  1453.                         $char = '';
  1454.                     }
  1455.                 }
  1456.                 $parts[$k][1] = ( isset($parts[$k][1]) ) ? $parts[$k][1] . $char : $char;
  1457.             }
  1458.             $HIGHLIGHTING_ON = '';
  1459.         }
  1460.         else {
  1461.             // Not strict mode - simply dump the source into
  1462.             // the array at index 1 (the first highlightable block)
  1463.             $parts = array(
  1464.                 1 => array(
  1465.                     0 => '',
  1466.                     1 => $code
  1467.                 )
  1468.             );
  1469.         }
  1470.  
  1471.         // Now we go through each part. We know that even-indexed parts are
  1472.         // code that shouldn't be highlighted, and odd-indexed parts should
  1473.         // be highlighted
  1474.         foreach ($parts as $key => $data) {
  1475.             $part = $data[1];
  1476.             // If this block should be highlighted...
  1477.             if ($key % 2) {
  1478.                 if ($this->strict_mode) {
  1479.                     // Find the class key for this block of code
  1480.                     foreach ($this->language_data['SCRIPT_DELIMITERS'] as $script_key => $script_data) {
  1481.                         foreach ($script_data as $open => $close) {
  1482.                             if ($data[0] == $open) {
  1483.                                 break(2);
  1484.                             }
  1485.                         }
  1486.                     }
  1487.  
  1488.                     if ($this->language_data['STYLES']['SCRIPT'][$script_key] != '' &&
  1489.                         $this->lexic_permissions['SCRIPT']) {
  1490.                         // Add a span element around the source to
  1491.                         // highlight the overall source block
  1492.                         if (!$this->use_classes &&
  1493.                             $this->language_data['STYLES']['SCRIPT'][$script_key] != '') {
  1494.                             $attributes = ' style="' . $this->language_data['STYLES']['SCRIPT'][$script_key] . '"';
  1495.                         }
  1496.                         else {
  1497.                             $attributes = ' class="sc' . $script_key . '"';
  1498.                         }
  1499.                         $result .= "<span$attributes>";
  1500.                         $STRICTATTRS = $attributes;
  1501.                     }
  1502.                 }
  1503.  
  1504.                 if (!$this->strict_mode || $this->language_data['HIGHLIGHT_STRICT_BLOCK'][$script_key]) {
  1505.                     // Now, highlight the code in this block. This code
  1506.                     // is really the engine of GeSHi (along with the method
  1507.                     // parse_non_string_part).
  1508.                     $length = strlen($part);
  1509.                     for ($i = 0; $i < $length; $i++) {
  1510.                         // Get the next char
  1511.                         $char = substr($part, $i, 1);
  1512.                         $hq = isset($this->language_data['HARDQUOTE']) ? $this->language_data['HARDQUOTE'][0] : false;
  1513.                         // Is this char the newline and line numbers being used?
  1514.                         if (($this->line_numbers != GESHI_NO_LINE_NUMBERS
  1515.                             || count($this->highlight_extra_lines) > 0)
  1516.                             && $char == "\n") {
  1517.                             // If so, is there a string open? If there is, we should end it before
  1518.                             // the newline and begin it again (so when <li>s are put in the source
  1519.                             // remains XHTML compliant)
  1520.                             // note to self: This opens up possibility of config files specifying
  1521.                             // that languages can/cannot have multiline strings???
  1522.                             if ($STRING_OPEN) {
  1523.                                 if (!$this->use_classes) {
  1524.                                     $attributes = ' style="' . $this->language_data['STYLES']['STRINGS'][0] . '"';
  1525.                                 }
  1526.                                 else {
  1527.                                     $attributes = ' class="st0"';
  1528.                                 }
  1529.                                 $char = '</span>' . $char . "<span$attributes>";
  1530.                             }
  1531.                         }
  1532.                         else if ($char == $STRING_OPEN) {
  1533.                             // A match of a string delimiter
  1534.                             if (($this->lexic_permissions['ESCAPE_CHAR'] && $ESCAPE_CHAR_OPEN) ||
  1535.                                 ($this->lexic_permissions['STRINGS'] && !$ESCAPE_CHAR_OPEN)) {
  1536.                                 $char = GeSHi::hsc($char) . '</span>';
  1537.                             }
  1538.                             $escape_me = false;
  1539.                             if ($HARDQUOTE_OPEN) {
  1540.                                 if ($ESCAPE_CHAR_OPEN) {
  1541.                                     $escape_me = true;
  1542.                                 }
  1543.                                 else {
  1544.                                     foreach ($this->language_data['HARDESCAPE'] as $hardesc) {
  1545.                                         if (substr($part, $i, strlen($hardesc)) == $hardesc) {
  1546.                                             $escape_me = true;
  1547.                                             break;
  1548.                                         }
  1549.                                     }
  1550.                                 }
  1551.                             }
  1552.  
  1553.                             if (!$ESCAPE_CHAR_OPEN) {
  1554.                                 $STRING_OPEN = '';
  1555.                                 $CLOSE_STRING = true;
  1556.                             }
  1557.                             if (!$escape_me) {
  1558.                                 $HARDQUOTE_OPEN = false;
  1559.                             }
  1560.                             $ESCAPE_CHAR_OPEN = false;
  1561.                         }
  1562.                         else if (in_array($char, $this->language_data['QUOTEMARKS']) &&
  1563.                             ($STRING_OPEN == '') && $this->lexic_permissions['STRINGS']) {
  1564.                             // The start of a new string
  1565.                             $STRING_OPEN = $char;
  1566.                             if (!$this->use_classes) {
  1567.                                 $attributes = ' style="' . $this->language_data['STYLES']['STRINGS'][0] . '"';
  1568.                             }
  1569.                             else {
  1570.                                 $attributes = ' class="st0"';
  1571.                             }
  1572.                             $char = "<span$attributes>" . GeSHi::hsc($char);
  1573.  
  1574.                             $result .= $this->parse_non_string_part( $stuff_to_parse );
  1575.                             $stuff_to_parse = '';
  1576.                         }
  1577.                         else if ($hq && substr($part, $i, strlen($hq)) == $hq &&
  1578.                             ($STRING_OPEN == '') && $this->lexic_permissions['STRINGS']) {
  1579.                             // The start of a hard quoted string
  1580.                             $STRING_OPEN = $this->language_data['HARDQUOTE'][1];
  1581.                             if (!$this->use_classes) {
  1582.                                 $attributes = ' style="' . $this->language_data['STYLES']['STRINGS'][0] . '"';
  1583.                             }
  1584.                             else {
  1585.                                 $attributes = ' class="st0"';
  1586.                             }
  1587.                             $char = "<span$attributes>" . $hq;
  1588.                             $i += strlen($hq) - 1;
  1589.                             $HARDQUOTE_OPEN = true;
  1590.                             $result .= $this->parse_non_string_part($stuff_to_parse);
  1591.                             $stuff_to_parse = '';
  1592.                         }
  1593.                         else if ($char == $this->language_data['ESCAPE_CHAR'] && $STRING_OPEN != '') {
  1594.                             // An escape character
  1595.                             if (!$ESCAPE_CHAR_OPEN) {
  1596.                                 $ESCAPE_CHAR_OPEN = !$HARDQUOTE_OPEN;  // true unless $HARDQUOTE_OPEN
  1597.                                 if ($HARDQUOTE_OPEN) {
  1598.                                     foreach ($this->language_data['HARDESCAPE'] as $hard) {
  1599.                                         if (substr($part, $i, strlen($hard)) == $hard) {
  1600.                                             $ESCAPE_CHAR_OPEN = true;
  1601.                                             break;
  1602.                                         }
  1603.                                     }
  1604.                                 }
  1605.                                 if ($ESCAPE_CHAR_OPEN && $this->lexic_permissions['ESCAPE_CHAR']) {
  1606.                                     if (!$this->use_classes) {
  1607.                                         $attributes = ' style="' . $this->language_data['STYLES']['ESCAPE_CHAR'][0] . '"';
  1608.                                     }
  1609.                                     else {
  1610.                                         $attributes = ' class="es0"';
  1611.                                     }
  1612.                                     $char = "<span$attributes>" . $char;
  1613.                                     if (substr($code, $i + 1, 1) == "\n") {
  1614.                                         // escaping a newline, what's the point in putting the span around
  1615.                                         // the newline? It only causes hassles when inserting line numbers
  1616.                                         $char .= '</span>';
  1617.                                         $ESCAPE_CHAR_OPEN = false;
  1618.                                     }
  1619.                                 }
  1620.                             }
  1621.                             else {
  1622.                                 $ESCAPE_CHAR_OPEN = false;
  1623.                                 if ($this->lexic_permissions['ESCAPE_CHAR']) {
  1624.                                     $char .= '</span>';
  1625.                                 }
  1626.                             }
  1627.                         }
  1628.                         else if ($ESCAPE_CHAR_OPEN) {
  1629.                             if ($this->lexic_permissions['ESCAPE_CHAR']) {
  1630.                                 $char .= '</span>';
  1631.                             }
  1632.                             $ESCAPE_CHAR_OPEN = false;
  1633.                             $test_str = $char;
  1634.                         }
  1635.                         else if ($STRING_OPEN == '') {
  1636.                             // Is this a multiline comment?
  1637.                             foreach ($this->language_data['COMMENT_MULTI'] as $open => $close) {
  1638.                                 $com_len = strlen($open);
  1639.                                 $test_str = substr( $part, $i, $com_len );
  1640.                                 $test_str_match = $test_str;
  1641.                                 if ($open == $test_str) {
  1642.                                     $COMMENT_MATCHED = true;
  1643.                                     //@todo If remove important do remove here
  1644.                                     if ($this->lexic_permissions['COMMENTS']['MULTI'] ||
  1645.                                         $test_str == GESHI_START_IMPORTANT) {
  1646.                                         if ($test_str != GESHI_START_IMPORTANT) {
  1647.                                             if (!$this->use_classes) {
  1648.                                                 $attributes = ' style="' . $this->language_data['STYLES']['COMMENTS']['MULTI'] . '"';
  1649.                                             }
  1650.                                             else {
  1651.                                                 $attributes = ' class="coMULTI"';
  1652.                                             }
  1653.                                             $test_str = "<span$attributes>" . GeSHi::hsc($test_str);
  1654.                                         }
  1655.                                         else {
  1656.                                             if (!$this->use_classes) {
  1657.                                                 $attributes = ' style="' . $this->important_styles . '"';
  1658.                                             }
  1659.                                             else {
  1660.                                                 $attributes = ' class="imp"';
  1661.                                             }
  1662.                                             // We don't include the start of the comment if it's an
  1663.                                             // "important" part
  1664.                                             $test_str = "<span$attributes>";
  1665.                                         }
  1666.                                     }
  1667.                                     else {
  1668.                                         $test_str = GeSHi::hsc($test_str);
  1669.                                     }
  1670.  
  1671.                                     $close_pos = strpos( $part, $close, $i + strlen($close) );
  1672.  
  1673.                                     $oops = false;
  1674.                                     if ($close_pos === false) {
  1675.                                         $close_pos = strlen($part);
  1676.                                         $oops = true;
  1677.                                     }
  1678.                                     else {
  1679.                                         $close_pos -= ($com_len - strlen($close));
  1680.                                     }
  1681.  
  1682.                                     // Short-cut through all the multiline code
  1683.                                     $rest_of_comment = GeSHi::hsc(substr($part, $i + $com_len, $close_pos - $i));
  1684.                                     if (($this->lexic_permissions['COMMENTS']['MULTI'] ||
  1685.                                         $test_str_match == GESHI_START_IMPORTANT) &&
  1686.                                         ($this->line_numbers != GESHI_NO_LINE_NUMBERS ||
  1687.                                         count($this->highlight_extra_lines) > 0)) {
  1688.                                         // strreplace to put close span and open span around multiline newlines
  1689.                                         $test_str .= str_replace("\n", "</span>\n<span$attributes>", $rest_of_comment);
  1690.                                     }
  1691.                                     else {
  1692.                                         $test_str .= $rest_of_comment;
  1693.                                     }
  1694.  
  1695.                                     if ($this->lexic_permissions['COMMENTS']['MULTI'] ||
  1696.                                         $test_str_match == GESHI_START_IMPORTANT) {
  1697.                                         $test_str .= '</span>';
  1698.                                         if ($oops) {
  1699.                                             $test_str .= "\n";
  1700.                                         }
  1701.                                     }
  1702.                                     $i = $close_pos + $com_len - 1;
  1703.                                     // parse the rest
  1704.                                     $result .= $this->parse_non_string_part($stuff_to_parse);
  1705.                                     $stuff_to_parse = '';
  1706.                                     break;
  1707.                                 }
  1708.                             }
  1709.                             // If we haven't matched a multiline comment, try single-line comments
  1710.                             if (!$COMMENT_MATCHED) {
  1711.                                 foreach ($this->language_data['COMMENT_SINGLE'] as $comment_key => $comment_mark) {
  1712.                                     $com_len = strlen($comment_mark);
  1713.                                     $test_str = substr($part, $i, $com_len);
  1714.                                     if ($this->language_data['CASE_SENSITIVE'][GESHI_COMMENTS]) {
  1715.                                         $match = ($comment_mark == $test_str);
  1716.                                     }
  1717.                                     else {
  1718.                                         $match = (strtolower($comment_mark) == strtolower($test_str));
  1719.                                     }
  1720.                                     if ($match) {
  1721.                                         $COMMENT_MATCHED = true;
  1722.                                         if ($this->lexic_permissions['COMMENTS'][$comment_key]) {
  1723.                                             if (!$this->use_classes) {
  1724.                                                 $attributes = ' style="' . $this->language_data['STYLES']['COMMENTS'][$comment_key] . '"';
  1725.                                             }
  1726.                                             else {
  1727.                                                 $attributes = ' class="co' . $comment_key . '"';
  1728.                                             }
  1729.                                             $test_str = "<span$attributes>" . GeSHi::hsc($this->change_case($test_str));
  1730.                                         }
  1731.                                         else {
  1732.                                             $test_str = GeSHi::hsc($test_str);
  1733.                                         }
  1734.                                         $close_pos = strpos($part, "\n", $i);
  1735.                                         $oops = false;
  1736.                                         if ($close_pos === false) {
  1737.                                             $close_pos = strlen($part);
  1738.                                             $oops = true;
  1739.                                         }
  1740.                                         $test_str .= GeSHi::hsc(substr($part, $i + $com_len, $close_pos - $i - $com_len));
  1741.                                         if ($this->lexic_permissions['COMMENTS'][$comment_key]) {
  1742.                                             $test_str .= "</span>";
  1743.                                         }
  1744.                                         // Take into account that the comment might be the last in the source
  1745.                                         if (!$oops) {
  1746.                                           $test_str .= "\n";
  1747.                                         }
  1748.                                         $i = $close_pos;
  1749.                                         // parse the rest
  1750.                                         $result .= $this->parse_non_string_part($stuff_to_parse);
  1751.                                         $stuff_to_parse = '';
  1752.                                         break;
  1753.                                     }
  1754.                                 }
  1755.                             }
  1756.                         }
  1757.                         else if ($STRING_OPEN != '') {
  1758.                             // Otherwise, convert it to HTML form
  1759.                             if (strtolower($this->encoding) == 'utf-8') {
  1760.                                 //only escape <128 (we don't want to break multibyte chars)
  1761.                                 if (ord($char) < 128) {
  1762.                                     $char = GeSHi::hsc($char);
  1763.                                 }
  1764.                             }
  1765.                             else {
  1766.                                 //encode everthing
  1767.                                 $char = GeSHi::hsc($char);
  1768.                             }
  1769.                         }
  1770.                         // Where are we adding this char?
  1771.                         if (!$COMMENT_MATCHED) {
  1772.                             if (($STRING_OPEN == '') && !$CLOSE_STRING) {
  1773.                                 $stuff_to_parse .= $char;
  1774.                             }
  1775.                             else {
  1776.                                 $result .= $char;
  1777.                                 $CLOSE_STRING = false;
  1778.                             }
  1779.                         }
  1780.                         else {
  1781.                             $result .= $test_str;
  1782.                             $COMMENT_MATCHED = false;
  1783.                         }
  1784.                     }
  1785.                     // Parse the last bit
  1786.                     $result .= $this->parse_non_string_part($stuff_to_parse);
  1787.                     $stuff_to_parse = '';
  1788.                 }
  1789.                 else {
  1790.                     if ($STRICTATTRS != '') {
  1791.                         $part = str_replace("\n", "</span>\n<span$STRICTATTRS>", GeSHi::hsc($part));
  1792.                         $STRICTATTRS = '';
  1793.                     }
  1794.                     $result .= $part;
  1795.                 }
  1796.                 // Close the <span> that surrounds the block
  1797.                 if ($this->strict_mode && $this->language_data['STYLES']['SCRIPT'][$script_key] != '' &&
  1798.                     $this->lexic_permissions['SCRIPT']) {
  1799.                     $result .= '</span>';
  1800.                 }
  1801.             }
  1802.             else {
  1803.                 // Else not a block to highlight
  1804.                 $result .= GeSHi::hsc($part);
  1805.             }
  1806.         }
  1807.  
  1808.         // Parse the last stuff (redundant?)
  1809.         $result .= $this->parse_non_string_part($stuff_to_parse);
  1810.  
  1811.         // Lop off the very first and last spaces
  1812.         $result = substr($result, 1, -1);
  1813.  
  1814.         // Are we still in a string?
  1815.         if ($STRING_OPEN) {
  1816.             $result .= '</span>';
  1817.         }
  1818.  
  1819.         // We're finished: stop timing
  1820.         $this->set_time($start_time, microtime());
  1821.  
  1822.         return $this->finalise($result);
  1823.     }
  1824.  
  1825.     /**
  1826.      * Swaps out spaces and tabs for HTML indentation. Not needed if
  1827.      * the code is in a pre block...
  1828.      *
  1829.      * @param  string The source to indent
  1830.      * @return string The source with HTML indenting applied
  1831.      * @since  1.0.0
  1832.      * @access private
  1833.      */
  1834.     function indent($result) {
  1835.         /// Replace tabs with the correct number of spaces
  1836.         if (false !== strpos($result, "\t")) {
  1837.             $lines = explode("\n", $result);
  1838.             foreach ($lines as $key => $line) {
  1839.                 if (false === strpos($line, "\t")) {
  1840.                     $lines[$key] = $line;
  1841.                     continue;
  1842.                 }
  1843.  
  1844.                 $pos = 0;
  1845.                 $tab_width = $this->tab_width;
  1846.                 $length = strlen($line);
  1847.                 $result_line = '';
  1848.  
  1849.                 $IN_TAG = false;
  1850.                 for ($i = 0; $i < $length; $i++) {
  1851.                     $char = substr($line, $i, 1);
  1852.                     // Simple engine to work out whether we're in a tag.
  1853.                     // If we are we modify $pos. This is so we ignore HTML
  1854.                     // in the line and only workout the tab replacement
  1855.                     // via the actual content of the string
  1856.                     // This test could be improved to include strings in the
  1857.                     // html so that < or > would be allowed in user's styles
  1858.                     // (e.g. quotes: '<' '>'; or similar)
  1859.                     if ($IN_TAG && '>' == $char) {
  1860.                         $IN_TAG = false;
  1861.                         $result_line .= '>';
  1862.                         ++$pos;
  1863.                     }
  1864.                     else if (!$IN_TAG && '<' == $char) {
  1865.                         $IN_TAG = true;
  1866.                         $result_line .= '<';
  1867.                         ++$pos;
  1868.                     }
  1869.                     else if (!$IN_TAG && '&' == $char) {
  1870.                         $substr = substr($line, $i + 3, 4);
  1871.                         //$substr_5 = substr($line, 5, 1);
  1872.                         $posi = strpos($substr, ';');
  1873.                         if (false !== $posi) {
  1874.                             $pos += $posi + 3;
  1875.                         }
  1876.                         $result_line .= '&';
  1877.                     }
  1878.                     else if (!$IN_TAG && "\t" == $char) {
  1879.                         $str = '';
  1880.                         // OPTIMISE - move $strs out. Make an array:
  1881.                         // $tabs = array(
  1882.                         //  1 => ' ',
  1883.                         //  2 => '  ',
  1884.                         //  3 => '   ' etc etc
  1885.                         // to use instead of building a string every time
  1886.                         $strs = array(0 => ' ', 1 => ' ');
  1887.                         for ($k = 0; $k < ($tab_width - (($i - $pos) % $tab_width)); $k++) $str .= $strs[$k % 2];
  1888.                         $result_line .= $str;
  1889.                         $pos++;
  1890.  
  1891.                         if (false === strpos($line, "\t", $i + 1)) {
  1892.                             $result_line .= substr($line, $i + 1);
  1893.                             break;
  1894.                         }
  1895.                     }
  1896.                     else if ($IN_TAG) {
  1897.                         ++$pos;
  1898.                         $result_line .= $char;
  1899.                     }
  1900.                     else {
  1901.                         $result_line .= $char;
  1902.                         //++$pos;
  1903.                     }
  1904.                 }
  1905.                 $lines[$key] = $result_line;
  1906.             }
  1907.             $result = implode("\n", $lines);
  1908.         }
  1909.         // Other whitespace
  1910.         $result = str_replace('  ', '  ', $result);
  1911.         $result = str_replace('  ', '  ', $result);
  1912.         $result = str_replace("\n ", "\n ", $result);
  1913.  
  1914.         if ($this->line_numbers == GESHI_NO_LINE_NUMBERS) {
  1915.             $result = nl2br($result);
  1916.         }
  1917.         return $result;
  1918.     }
  1919.  
  1920.     /**
  1921.      * Changes the case of a keyword for those languages where a change is asked for
  1922.      *
  1923.      * @param  string The keyword to change the case of
  1924.      * @return string The keyword with its case changed
  1925.      * @since  1.0.0
  1926.      * @access private
  1927.      */
  1928.     function change_case($instr) {
  1929.         if ($this->language_data['CASE_KEYWORDS'] == GESHI_CAPS_UPPER) {
  1930.             return strtoupper($instr);
  1931.         }
  1932.         else if ($this->language_data['CASE_KEYWORDS'] == GESHI_CAPS_LOWER) {
  1933.             return strtolower($instr);
  1934.         }
  1935.         return $instr;
  1936.     }
  1937.  
  1938.     /**
  1939.      * Adds a url to a keyword where needed.
  1940.      *
  1941.      * @param  string The keyword to add the URL HTML to
  1942.      * @param  int What group the keyword is from
  1943.      * @param  boolean Whether to get the HTML for the start or end
  1944.      * @return The HTML for either the start or end of the HTML <a> tag
  1945.      * @since  1.0.2
  1946.      * @access private
  1947.      * @todo   Get rid of ender
  1948.      */
  1949.     function add_url_to_keyword($keyword, $group, $start_or_end) {
  1950.         if (!$this->keyword_links) {
  1951.             // Keyword links have been disabled
  1952.             return;
  1953.         }
  1954.  
  1955.         if (isset($this->language_data['URLS'][$group]) &&
  1956.             $this->language_data['URLS'][$group] != '' &&
  1957.             substr($keyword, 0, 5) != '</') {
  1958.             // There is a base group for this keyword
  1959.             if ($start_or_end == 'BEGIN') {
  1960.                 // HTML workaround... not good form (tm) but should work for 1.0.X
  1961.                 if ($keyword != '') {
  1962.                     // Old system: strtolower
  1963.                     //$keyword = ( $this->language_data['CASE_SENSITIVE'][$group] ) ? $keyword : strtolower($keyword);
  1964.                     // New system: get keyword from language file to get correct case
  1965.                     foreach ($this->language_data['KEYWORDS'][$group] as $word) {
  1966.                         if (strtolower($word) == strtolower($keyword)) {
  1967.                             break;
  1968.                         }
  1969.                     }
  1970.                     $word = ( substr($word, 0, 4) == '<' ) ? substr($word, 4) : $word;
  1971.                     $word = ( substr($word, -4) == '>' ) ? substr($word, 0, strlen($word) - 4) : $word;
  1972.                     if (!$word) return '';
  1973.  
  1974.                     return '<|UR1|"' .
  1975.                         str_replace(
  1976.                             array('{FNAME}', '.'),
  1977.                             array(GeSHi::hsc($word), '<DOT>'),
  1978.                             $this->language_data['URLS'][$group]
  1979.                         ) . '">';
  1980.                 }
  1981.                 return '';
  1982.             // HTML fix. Again, dirty hackage...
  1983.             }
  1984.             else if (!($this->language == 'html4strict' && ('>' == $keyword || '<' == $keyword))) {
  1985.                 return '</a>';
  1986.             }
  1987.         }
  1988.     }
  1989.  
  1990.     /**
  1991.      * Takes a string that has no strings or comments in it, and highlights
  1992.      * stuff like keywords, numbers and methods.
  1993.      *
  1994.      * @param string The string to parse for keyword, numbers etc.
  1995.      * @since 1.0.0
  1996.      * @access private
  1997.      * @todo BUGGY! Why? Why not build string and return?
  1998.      */
  1999.     function parse_non_string_part(&$stuff_to_parse) {
  2000.         $stuff_to_parse = ' ' . GeSHi::hsc($stuff_to_parse);
  2001.         $stuff_to_parse_pregquote = preg_quote($stuff_to_parse, '/');
  2002.         $func = '$this->change_case';
  2003.         $func2 = '$this->add_url_to_keyword';
  2004.  
  2005.         //
  2006.         // Regular expressions
  2007.         //
  2008.         foreach ($this->language_data['REGEXPS'] as $key => $regexp) {
  2009.             if ($this->lexic_permissions['REGEXPS'][$key]) {
  2010.                 if (is_array($regexp)) {
  2011.                     $stuff_to_parse = preg_replace(
  2012.                         "/" .
  2013.                         str_replace('/', '\/', $regexp[GESHI_SEARCH]) .
  2014.                         "/{$regexp[GESHI_MODIFIERS]}",
  2015.                         "{$regexp[GESHI_BEFORE]}<|!REG3XP$key!>{$regexp[GESHI_REPLACE]}|>{$regexp[GESHI_AFTER]}",
  2016.                         $stuff_to_parse
  2017.                     );
  2018.                 }
  2019.                 else {
  2020.                     $stuff_to_parse = preg_replace( "/(" . str_replace('/', '\/', $regexp) . ")/", "<|!REG3XP$key!>\\1|>", $stuff_to_parse);
  2021.                 }
  2022.             }
  2023.         }
  2024.  
  2025.         //
  2026.         // Highlight numbers. This regexp sucks... anyone with a regexp that WORKS
  2027.         // here wins a cookie if they send it to me. At the moment there's two doing
  2028.         // almost exactly the same thing, except the second one prevents a number
  2029.         // being highlighted twice (eg <span...><span...>5</span></span>)
  2030.         // Put /NUM!/ in for the styles, which gets replaced at the end.
  2031.         //
  2032.         // NEW ONE: Brice Bernard
  2033.         //
  2034.         if ($this->lexic_permissions['NUMBERS'] && preg_match('#[0-9]#', $stuff_to_parse )) {
  2035.             $stuff_to_parse = preg_replace('/([-+]?\\b(?:[0-9]*\\.)?[0-9]+\\b)/', '<|/NUM!/>\\1|>', $stuff_to_parse);
  2036.         }
  2037.  
  2038.         // Highlight keywords
  2039.         // if there is a couple of alpha symbols there *might* be a keyword
  2040.         if (preg_match('#[a-zA-Z]{2,}#', $stuff_to_parse)) {
  2041.             foreach ($this->language_data['KEYWORDS'] as $k => $keywordset) {
  2042.                 if ($this->lexic_permissions['KEYWORDS'][$k]) {
  2043.                     foreach ($keywordset as $keyword) {
  2044.                         $keyword = preg_quote($keyword, '/');
  2045.                         //
  2046.                         // This replacement checks the word is on it's own (except if brackets etc
  2047.                         // are next to it), then highlights it. We don't put the color=" for the span
  2048.                         // in just yet - otherwise languages with the keywords "color" or "or" have
  2049.                         // a fit.
  2050.                         //
  2051.                         if (false !== stristr($stuff_to_parse_pregquote, $keyword )) {
  2052.                             $stuff_to_parse .= ' ';
  2053.                             // Might make a more unique string for putting the number in soon
  2054.                             // Basically, we don't put the styles in yet because then the styles themselves will
  2055.                             // get highlighted if the language has a CSS keyword in it (like CSS, for example ;))
  2056.                             $styles = "/$k/";
  2057.                             if ($this->language_data['CASE_SENSITIVE'][$k]) {
  2058.                                 $stuff_to_parse = preg_replace(
  2059.                                     "/([^a-zA-Z0-9\$_\|\#;>|^])($keyword)(?=[^a-zA-Z0-9_<\|%\-&])/e",
  2060.                                     "'\\1' . $func2('\\2', '$k', 'BEGIN') . '<|$styles>' . $func('\\2') . '|>' . $func2('\\2', '$k', 'END')",
  2061.                                     $stuff_to_parse
  2062.                                 );
  2063.                             }
  2064.                             else {
  2065.                                 // Change the case of the word.
  2066.                                 // hackage again... must... release... 1.2...
  2067.                                 if ('smarty' == $this->language) { $hackage = '\/'; } else { $hackage = ''; }
  2068.                                 $stuff_to_parse = preg_replace(
  2069.                                     "/([^a-zA-Z0-9\$_\|\#;>$hackage|^])($keyword)(?=[^a-zA-Z0-9_<\|%\-&])/ie",
  2070.                                     "'\\1' . $func2('\\2', '$k', 'BEGIN') . '<|$styles>' . $func('\\2') . '|>' . $func2('\\2', '$k', 'END')",
  2071.                                     $stuff_to_parse
  2072.                                 );
  2073.                             }
  2074.                             $stuff_to_parse = substr($stuff_to_parse, 0, strlen($stuff_to_parse) - 1);
  2075.                         }
  2076.                     }
  2077.                 }
  2078.             }
  2079.         }
  2080.  
  2081.         //
  2082.         // Now that's all done, replace /[number]/ with the correct styles
  2083.         //
  2084.         foreach ($this->language_data['KEYWORDS'] as $k => $kws) {
  2085.             if (!$this->use_classes) {
  2086.                 $attributes = ' style="' . $this->language_data['STYLES']['KEYWORDS'][$k] . '"';
  2087.             }
  2088.             else {
  2089.                 $attributes = ' class="kw' . $k . '"';
  2090.             }
  2091.             $stuff_to_parse = str_replace("/$k/", $attributes, $stuff_to_parse);
  2092.         }
  2093.  
  2094.         // Put number styles in
  2095.         if (!$this->use_classes && $this->lexic_permissions['NUMBERS']) {
  2096.             $attributes = ' style="' . $this->language_data['STYLES']['NUMBERS'][0] . '"';
  2097.         }
  2098.         else {
  2099.             $attributes = ' class="nu0"';
  2100.         }
  2101.         $stuff_to_parse = str_replace('/NUM!/', $attributes, $stuff_to_parse);
  2102.  
  2103.         //
  2104.         // Highlight methods and fields in objects
  2105.         //
  2106.         if ($this->lexic_permissions['METHODS'] && $this->language_data['OOLANG']) {
  2107.             foreach ($this->language_data['OBJECT_SPLITTERS'] as $key => $splitter) {
  2108.                 if (false !== stristr($stuff_to_parse, $splitter)) {
  2109.                     if (!$this->use_classes) {
  2110.                         $attributes = ' style="' . $this->language_data['STYLES']['METHODS'][$key] . '"';
  2111.                     }
  2112.                     else {
  2113.                         $attributes = ' class="me' . $key . '"';
  2114.                     }
  2115.                     $stuff_to_parse = preg_replace("/(" . preg_quote($this->language_data['OBJECT_SPLITTERS'][$key], 1) . "[\s]*)([a-zA-Z\*\(][a-zA-Z0-9_\*]*)/", "\\1<|$attributes>\\2|>", $stuff_to_parse);
  2116.                 }
  2117.             }
  2118.         }
  2119.  
  2120.         //
  2121.         // Highlight brackets. Yes, I've tried adding a semi-colon to this list.
  2122.         // You try it, and see what happens ;)
  2123.         // TODO: Fix lexic permissions not converting entities if shouldn't
  2124.         // be highlighting regardless
  2125.         //
  2126.         if ($this->lexic_permissions['BRACKETS']) {
  2127.             $code_entities_match = array('[', ']', '(', ')', '{', '}');
  2128.             if (!$this->use_classes) {
  2129.                 $code_entities_replace = array(
  2130.                     '<| style="' . $this->language_data['STYLES']['BRACKETS'][0] . '">[|>',
  2131.                     '<| style="' . $this->language_data['STYLES']['BRACKETS'][0] . '">]|>',
  2132.                     '<| style="' . $this->language_data['STYLES']['BRACKETS'][0] . '">(|>',
  2133.                     '<| style="' . $this->language_data['STYLES']['BRACKETS'][0] . '">)|>',
  2134.                     '<| style="' . $this->language_data['STYLES']['BRACKETS'][0] . '">{|>',
  2135.                     '<| style="' . $this->language_data['STYLES']['BRACKETS'][0] . '">}|>',
  2136.                 );
  2137.             }
  2138.             else {
  2139.                 $code_entities_replace = array(
  2140.                     '<| class="br0">[|>',
  2141.                     '<| class="br0">]|>',
  2142.                     '<| class="br0">(|>',
  2143.                     '<| class="br0">)|>',
  2144.                     '<| class="br0">{|>',
  2145.                     '<| class="br0">}|>',
  2146.                 );
  2147.             }
  2148.             $stuff_to_parse = str_replace( $code_entities_match,  $code_entities_replace, $stuff_to_parse );
  2149.         }
  2150.  
  2151.         //
  2152.         // Add class/style for regexps
  2153.         //
  2154.         foreach ($this->language_data['REGEXPS'] as $key => $regexp) {
  2155.             if ($this->lexic_permissions['REGEXPS'][$key]) {
  2156.                 if (!$this->use_classes) {
  2157.                     $attributes = ' style="' . $this->language_data['STYLES']['REGEXPS'][$key] . '"';
  2158.                 }
  2159.                 else {
  2160.                    if(is_array($this->language_data['REGEXPS'][$key]) &&
  2161.                             array_key_exists(GESHI_CLASS, $this->language_data['REGEXPS'][$key])) {
  2162.                         $attributes = ' class="'
  2163.                             . $this->language_data['REGEXPS'][$key][GESHI_CLASS] . '"';
  2164.                     }
  2165.                    else {
  2166.                        $attributes = ' class="re' . $key . '"';
  2167.                     }
  2168.                 }
  2169.                 $stuff_to_parse = str_replace("!REG3XP$key!", "$attributes", $stuff_to_parse);
  2170.             }
  2171.         }
  2172.  
  2173.         // Replace <DOT> with . for urls
  2174.         $stuff_to_parse = str_replace('<DOT>', '.', $stuff_to_parse);
  2175.         // Replace <|UR1| with <a href= for urls also
  2176.         if (isset($this->link_styles[GESHI_LINK])) {
  2177.             if ($this->use_classes) {
  2178.                 $stuff_to_parse = str_replace('<|UR1|', '<a' . $this->link_target . ' href=', $stuff_to_parse);
  2179.             }
  2180.             else {
  2181.                 $stuff_to_parse = str_replace('<|UR1|', '<a' . $this->link_target . ' style="' . $this->link_styles[GESHI_LINK] . '" href=', $stuff_to_parse);
  2182.             }
  2183.         }
  2184.         else {
  2185.             $stuff_to_parse = str_replace('<|UR1|', '<a' . $this->link_target . ' href=', $stuff_to_parse);
  2186.         }
  2187.  
  2188.         //
  2189.         // NOW we add the span thingy ;)
  2190.         //
  2191.  
  2192.         $stuff_to_parse = str_replace('<|', '<span', $stuff_to_parse);
  2193.         $stuff_to_parse = str_replace ( '|>', '</span>', $stuff_to_parse );
  2194.  
  2195.         return substr($stuff_to_parse, 1);
  2196.     }
  2197.  
  2198.     /**
  2199.      * Sets the time taken to parse the code
  2200.      *
  2201.      * @param microtime The time when parsing started
  2202.      * @param microtime The time when parsing ended
  2203.      * @since 1.0.2
  2204.      * @access private
  2205.      */
  2206.     function set_time($start_time, $end_time) {
  2207.         $start = explode(' ', $start_time);
  2208.         $end = explode(' ', $end_time);
  2209.         $this->time = $end[0] + $end[1] - $start[0] - $start[1];
  2210.     }
  2211.  
  2212.     /**
  2213.      * Gets the time taken to parse the code
  2214.      *
  2215.      * @return double The time taken to parse the code
  2216.      * @since  1.0.2
  2217.      */
  2218.     function get_time() {
  2219.         return $this->time;
  2220.     }
  2221.  
  2222.     /**
  2223.      * Gets language information and stores it for later use
  2224.      *
  2225.      * @access private
  2226.      * @todo Needs to load keys for lexic permissions for keywords, regexps etc
  2227.      */
  2228.     function load_language($file_name) {
  2229.         $this->enable_highlighting();
  2230.         $language_data = array();
  2231.         require $file_name;
  2232.         // Perhaps some checking might be added here later to check that
  2233.         // $language data is a valid thing but maybe not
  2234.         $this->language_data = $language_data;
  2235.         // Set strict mode if should be set
  2236.         if ($this->language_data['STRICT_MODE_APPLIES'] == GESHI_ALWAYS) {
  2237.             $this->strict_mode = true;
  2238.         }
  2239.         // Set permissions for all lexics to true
  2240.         // so they'll be highlighted by default
  2241.         foreach ($this->language_data['KEYWORDS'] as $key => $words) {
  2242.             $this->lexic_permissions['KEYWORDS'][$key] = true;
  2243.         }
  2244.         foreach ($this->language_data['COMMENT_SINGLE'] as $key => $comment) {
  2245.             $this->lexic_permissions['COMMENTS'][$key] = true;
  2246.         }
  2247.         foreach ($this->language_data['REGEXPS'] as $key => $regexp) {
  2248.             $this->lexic_permissions['REGEXPS'][$key] = true;
  2249.         }
  2250.         // Set default class for CSS
  2251.         $this->overall_class = $this->language;
  2252.     }
  2253.  
  2254.     /**
  2255.      * Takes the parsed code and various options, and creates the HTML
  2256.      * surrounding it to make it look nice.
  2257.      *
  2258.      * @param  string The code already parsed
  2259.      * @return string The code nicely finalised
  2260.      * @since  1.0.0
  2261.      * @access private
  2262.      */
  2263.     function finalise($parsed_code) {
  2264.         // Remove end parts of important declarations
  2265.         // This is BUGGY!! My fault for bad code: fix coming in 1.2
  2266.         // @todo Remove this crap
  2267.         if ($this->enable_important_blocks &&
  2268.             (strstr($parsed_code, GeSHi::hsc(GESHI_START_IMPORTANT)) === false)) {
  2269.             $parsed_code = str_replace(GeSHi::hsc(GESHI_END_IMPORTANT), '', $parsed_code);
  2270.         }
  2271.  
  2272.         // Add HTML whitespace stuff if we're using the <div> header
  2273.         if ($this->header_type != GESHI_HEADER_PRE) {
  2274.             $parsed_code = $this->indent($parsed_code);
  2275.         }
  2276.  
  2277.         // purge some unnecessary stuff
  2278.         $parsed_code = preg_replace('#<span[^>]+>(\s*)</span>#', '\\1', $parsed_code);
  2279.         $parsed_code = preg_replace('#<div[^>]+>(\s*)</div>#', '\\1', $parsed_code);
  2280.  
  2281.         // If we are using IDs for line numbers, there needs to be an overall
  2282.         // ID set to prevent collisions.
  2283.         if ($this->add_ids && !$this->overall_id) {
  2284.             $this->overall_id = 'geshi-' . substr(md5(microtime()), 0, 4);
  2285.         }
  2286.  
  2287.         // If we're using line numbers, we insert <li>s and appropriate
  2288.         // markup to style them (otherwise we don't need to do anything)
  2289.         if ($this->line_numbers != GESHI_NO_LINE_NUMBERS) {
  2290.             // If we're using the <pre> header, we shouldn't add newlines because
  2291.             // the <pre> will line-break them (and the <li>s already do this for us)
  2292.             $ls = ($this->header_type != GESHI_HEADER_PRE) ? "\n" : '';
  2293.             // Get code into lines
  2294.             $code = explode("\n", $parsed_code);
  2295.             // Set vars to defaults for following loop
  2296.             $parsed_code = '';
  2297.             $i = 0;
  2298.             $attrs = array();
  2299.  
  2300.             // Foreach line...
  2301.             foreach ($code as $line) {
  2302.                 // Make lines have at least one space in them if they're empty
  2303.                 // BenBE: Checking emptiness using trim instead of relying on blanks
  2304.                 if ('' == trim($line)) {
  2305.                     $line = ' ';
  2306.                 }
  2307.                 // If this is a "special line"...
  2308.                 if ($this->line_numbers == GESHI_FANCY_LINE_NUMBERS &&
  2309.                     $i % $this->line_nth_row == ($this->line_nth_row - 1)) {
  2310.                     // Set the attributes to style the line
  2311.                     if ($this->use_classes) {
  2312.                         //$attr = ' class="li2"';
  2313.                         $attrs['class'][] = 'li2';
  2314.                         $def_attr = ' class="de2"';
  2315.                     }
  2316.                     else {
  2317.                         //$attr = ' style="' . $this->line_style2 . '"';
  2318.                         $attrs['style'][] = $this->line_style2;
  2319.                         // This style "covers up" the special styles set for special lines
  2320.                         // so that styles applied to special lines don't apply to the actual
  2321.                         // code on that line
  2322.                         $def_attr = ' style="' . $this->code_style . '"';
  2323.                     }
  2324.                     // Span or div?
  2325.                     $start = "<div$def_attr>";
  2326.                     $end = '</div>';
  2327.                 }
  2328.                 else {
  2329.                     if ($this->use_classes) {
  2330.                         //$attr = ' class="li1"';
  2331.                         $attrs['class'][] = 'li1';
  2332.                         $def_attr = ' class="de1"';
  2333.                     }
  2334.                     else {
  2335.                         //$attr = ' style="' . $this->line_style1 . '"';
  2336.                         $attrs['style'][] = $this->line_style1;
  2337.                         $def_attr = ' style="' . $this->code_style . '"';
  2338.                     }
  2339.                     $start = "<div$def_attr>";
  2340.                     $end = '</div>';
  2341.                 }
  2342.  
  2343.                 ++$i;
  2344.                 // Are we supposed to use ids? If so, add them
  2345.                 if ($this->add_ids) {
  2346.                     $attrs['id'][] = "$this->overall_id-$i";
  2347.                 }
  2348.                 if ($this->use_classes && in_array($i, $this->highlight_extra_lines)) {
  2349.                     $attrs['class'][] = 'ln-xtra';
  2350.                 }
  2351.                 if (!$this->use_classes && in_array($i, $this->highlight_extra_lines)) {
  2352.                     $attrs['style'][] = $this->highlight_extra_lines_style;
  2353.                 }
  2354.  
  2355.                 // Add in the line surrounded by appropriate list HTML
  2356.                 $attr_string = ' ';
  2357.                 foreach ($attrs as $key => $attr) {
  2358.                     $attr_string .= $key . '="' . implode(' ', $attr) . '" ';
  2359.                 }
  2360.                 $attr_string = substr($attr_string, 0, -1);
  2361.                 $parsed_code .= "<li$attr_string>$start$line$end</li>$ls";
  2362.                 $attrs = array();
  2363.             }
  2364.         }
  2365.         else {
  2366.             // No line numbers, but still need to handle highlighting lines extra.
  2367.             // Have to use divs so the full width of the code is highlighted
  2368.             $code = explode("\n", $parsed_code);
  2369.             $parsed_code = '';
  2370.             $i = 0;
  2371.             foreach ($code as $line) {
  2372.                 // Make lines have at least one space in them if they're empty
  2373.                 // BenBE: Checking emptiness using trim instead of relying on blanks
  2374.                 if ('' == trim($line)) {
  2375.                     $line = ' ';
  2376.                 }
  2377.                 if (in_array(++$i, $this->highlight_extra_lines)) {
  2378.                     if ($this->use_classes) {
  2379.                         $parsed_code .= '<div class="ln-xtra">';
  2380.                     }
  2381.                     else {
  2382.                         $parsed_code .= "<div style=\"{$this->highlight_extra_lines_style}\">";
  2383.                     }
  2384.                     // Remove \n because it stuffs up <pre> header
  2385.                     $parsed_code .= $line . "</div>";
  2386.                 }
  2387.                 else {
  2388.                     $parsed_code .= $line . "\n";
  2389.                 }
  2390.             }
  2391.         }
  2392.  
  2393.         if ($this->header_type == GESHI_HEADER_PRE) {
  2394.             // enforce line numbers when using pre
  2395.             $parsed_code = str_replace('<li></li>', '<li> </li>', $parsed_code);
  2396.         }
  2397.  
  2398.         return $this->header() . chop($parsed_code) . $this->footer();
  2399.     }
  2400.  
  2401.     /**
  2402.      * Creates the header for the code block (with correct attributes)
  2403.      *
  2404.      * @return string The header for the code block
  2405.      * @since  1.0.0
  2406.      * @access private
  2407.      */
  2408.     function header() {
  2409.         // Get attributes needed
  2410.         $attributes = $this->get_attributes();
  2411.  
  2412.         $ol_attributes = '';
  2413.  
  2414.         if ($this->line_numbers_start != 1) {
  2415.             $ol_attributes .= ' start="' . $this->line_numbers_start . '"';
  2416.         }
  2417.  
  2418.         // Get the header HTML
  2419.         $header = $this->format_header_content();
  2420.  
  2421.         if (GESHI_HEADER_NONE == $this->header_type) {
  2422.             if ($this->line_numbers != GESHI_NO_LINE_NUMBERS) {
  2423.                 return "$header<ol$ol_attributes>";
  2424.             }
  2425.             return $header;
  2426.         }
  2427.  
  2428.         // Work out what to return and do it
  2429.         if ($this->line_numbers != GESHI_NO_LINE_NUMBERS) {
  2430.             if ($this->header_type == GESHI_HEADER_PRE) {
  2431.                 return "<pre$attributes>$header<ol$ol_attributes>";
  2432.             }
  2433.             else if ($this->header_type == GESHI_HEADER_DIV) {
  2434.                 return "<div$attributes>$header<ol$ol_attributes>";
  2435.             }
  2436.         }
  2437.         else {
  2438.             if ($this->header_type == GESHI_HEADER_PRE) {
  2439.                 return "<pre$attributes>$header";
  2440.             }
  2441.             else if ($this->header_type == GESHI_HEADER_DIV) {
  2442.                 return "<div$attributes>$header";
  2443.             }
  2444.         }
  2445.     }
  2446.  
  2447.     /**
  2448.      * Returns the header content, formatted for output
  2449.      *
  2450.      * @return string The header content, formatted for output
  2451.      * @since  1.0.2
  2452.      * @access private
  2453.      */
  2454.     function format_header_content() {
  2455.         $header = $this->header_content;
  2456.         if ($header) {
  2457.             if ($this->header_type == GESHI_HEADER_PRE) {
  2458.                 $header = str_replace("\n", '', $header);
  2459.             }
  2460.             $header = $this->replace_keywords($header);
  2461.  
  2462.             if ($this->use_classes) {
  2463.                 $attr = ' class="head"';
  2464.             }
  2465.             else {
  2466.                 $attr = " style=\"{$this->header_content_style}\"";
  2467.             }
  2468.             return "<div$attr>$header</div>";
  2469.         }
  2470.     }
  2471.  
  2472.     /**
  2473.      * Returns the footer for the code block.
  2474.      *
  2475.      * @return string The footer for the code block
  2476.      * @since  1.0.0
  2477.      * @access private
  2478.      */
  2479.     function footer() {
  2480.         $footer_content = $this->format_footer_content();
  2481.  
  2482.         if (GESHI_HEADER_NONE == $this->header_type) {
  2483.             return ($this->line_numbers != GESHI_NO_LINE_NUMBERS) ? '</ol>' . $footer_content
  2484.                 : $footer_content;
  2485.         }
  2486.  
  2487.         if ($this->header_type == GESHI_HEADER_DIV) {
  2488.             if ($this->line_numbers != GESHI_NO_LINE_NUMBERS) {
  2489.                 return "</ol>$footer_content</div>";
  2490.             }
  2491.             return "$footer_content</div>";
  2492.         }
  2493.         else {
  2494.             if ($this->line_numbers != GESHI_NO_LINE_NUMBERS) {
  2495.                 return "</ol>$footer_content</pre>";
  2496.             }
  2497.             return "$footer_content</pre>";
  2498.         }
  2499.     }
  2500.  
  2501.     /**
  2502.      * Returns the footer content, formatted for output
  2503.      *
  2504.      * @return string The footer content, formatted for output
  2505.      * @since  1.0.2
  2506.      * @access private
  2507.      */
  2508.     function format_footer_content() {
  2509.         $footer = $this->footer_content;
  2510.         if ($footer) {
  2511.             if ($this->header_type == GESHI_HEADER_PRE) {
  2512.                 $footer = str_replace("\n", '', $footer);;
  2513.             }
  2514.             $footer = $this->replace_keywords($footer);
  2515.  
  2516.             if ($this->use_classes) {
  2517.                 $attr = ' class="foot"';
  2518.             }
  2519.             else {
  2520.                 $attr = " style=\"{$this->footer_content_style}\"";
  2521.             }
  2522.             return "<div$attr>$footer</div>";
  2523.         }
  2524.     }
  2525.  
  2526.     /**
  2527.      * Replaces certain keywords in the header and footer with
  2528.      * certain configuration values
  2529.      *
  2530.      * @param  string The header or footer content to do replacement on
  2531.      * @return string The header or footer with replaced keywords
  2532.      * @since  1.0.2
  2533.      * @access private
  2534.      */
  2535.     function replace_keywords($instr) {
  2536.         $keywords = $replacements = array();
  2537.  
  2538.         $keywords[] = '<TIME>';
  2539.         $keywords[] = '{TIME}';
  2540.         $replacements[] = $replacements[] = number_format($this->get_time(), 3);
  2541.  
  2542.         $keywords[] = '<LANGUAGE>';
  2543.         $keywords[] = '{LANGUAGE}';
  2544.         $replacements[] = $replacements[] = $this->language;
  2545.  
  2546.         $keywords[] = '<VERSION>';
  2547.         $keywords[] = '{VERSION}';
  2548.         $replacements[] = $replacements[] = GESHI_VERSION;
  2549.  
  2550.         return str_replace($keywords, $replacements, $instr);
  2551.     }
  2552.  
  2553.     /**
  2554.      * Gets the CSS attributes for this code
  2555.      *
  2556.      * @return The CSS attributes for this code
  2557.      * @since  1.0.0
  2558.      * @access private
  2559.      * @todo   Document behaviour change - class is outputted regardless of whether we're using classes or not.
  2560.      *         Same with style
  2561.      */
  2562.     function get_attributes() {
  2563.         $attributes = '';
  2564.  
  2565.         if ($this->overall_class != '') {
  2566.             $attributes .= " class=\"{$this->overall_class}\"";
  2567.         }
  2568.         if ($this->overall_id != '') {
  2569.             $attributes .= " id=\"{$this->overall_id}\"";
  2570.         }
  2571.         if ($this->overall_style != '') {
  2572.             $attributes .= ' style="' . $this->overall_style . '"';
  2573.         }
  2574.         return $attributes;
  2575.     }
  2576.  
  2577.     /**
  2578.      * Secure replacement for PHP built-in function htmlspecialchars().
  2579.      *
  2580.      * See ticket #427 (http://wush.net/trac/wikka/ticket/427) for the rationale
  2581.      * for this replacement function.
  2582.      *
  2583.      * The INTERFACE for this function is almost the same as that for
  2584.      * htmlspecialchars(), with the same default for quote style; however, there
  2585.      * is no 'charset' parameter. The reason for this is as follows:
  2586.      *
  2587.      * The PHP docs say:
  2588.      *      "The third argument charset defines character set used in conversion."
  2589.      *
  2590.      * I suspect PHP's htmlspecialchars() is working at the byte-value level and
  2591.      * thus _needs_ to know (or asssume) a character set because the special
  2592.      * characters to be replaced could exist at different code points in
  2593.      * different character sets. (If indeed htmlspecialchars() works at
  2594.      * byte-value level that goes some  way towards explaining why the
  2595.      * vulnerability would exist in this function, too, and not only in
  2596.      * htmlentities() which certainly is working at byte-value level.)
  2597.      *
  2598.      * This replacement function however works at character level and should
  2599.      * therefore be "immune" to character set differences - so no charset
  2600.      * parameter is needed or provided. If a third parameter is passed, it will
  2601.      * be silently ignored.
  2602.      *
  2603.      * In the OUTPUT there is a minor difference in that we use ''' instead
  2604.      * of PHP's ''' for a single quote: this provides compatibility with
  2605.      *      get_html_translation_table(HTML_SPECIALCHARS, ENT_QUOTES)
  2606.      * (see comment by mikiwoz at yahoo dot co dot uk on
  2607.      * http://php.net/htmlspecialchars); it also matches the entity definition
  2608.      * for XML 1.0
  2609.      * (http://www.w3.org/TR/xhtml1/dtds.html#a_dtd_Special_characters).
  2610.      * Like PHP we use a numeric character reference instead of ''' for the
  2611.      * single quote. For the other special characters we use the named entity
  2612.      * references, as PHP is doing.
  2613.      *
  2614.      * @author      {@link http://wikkawiki.org/JavaWoman Marjolein Katsma}
  2615.      *
  2616.      * @license     http://www.gnu.org/copyleft/lgpl.html
  2617.      *              GNU Lesser General Public License
  2618.      * @copyright   Copyright 2007, {@link http://wikkawiki.org/CreditsPage
  2619.      *              Wikka Development Team}
  2620.      *
  2621.      * @access      public
  2622.      * @param       string  $string string to be converted
  2623.      * @param       integer $quote_style
  2624.      *                      - ENT_COMPAT:   escapes &, <, > and double quote (default)
  2625.      *                      - ENT_NOQUOTES: escapes only &, < and >
  2626.      *                      - ENT_QUOTES:   escapes &, <, >, double and single quotes
  2627.      * @return      string  converted string
  2628.      */
  2629.     function hsc($string, $quote_style=ENT_COMPAT) {
  2630.         // init
  2631.         $aTransSpecchar = array(
  2632.             '&' => '&',
  2633.             '"' => '"',
  2634.             '<' => '<',
  2635.             '>' => '>'
  2636.             );                      // ENT_COMPAT set
  2637.  
  2638.         if (ENT_NOQUOTES == $quote_style)       // don't convert double quotes
  2639.         {
  2640.             unset($aTransSpecchar['"']);
  2641.         }
  2642.         elseif (ENT_QUOTES == $quote_style)     // convert single quotes as well
  2643.         {
  2644.             $aTransSpecchar["'"] = '''; // (apos) htmlspecialchars() uses '''
  2645.         }
  2646.  
  2647.         // return translated string
  2648.         return strtr($string,$aTransSpecchar);
  2649.     }
  2650.  
  2651.     /**
  2652.      * Returns a stylesheet for the highlighted code. If $economy mode
  2653.      * is true, we only return the stylesheet declarations that matter for
  2654.      * this code block instead of the whole thing
  2655.      *
  2656.      * @param  boolean Whether to use economy mode or not
  2657.      * @return string A stylesheet built on the data for the current language
  2658.      * @since  1.0.0
  2659.      */
  2660.     function get_stylesheet($economy_mode = true) {
  2661.         // If there's an error, chances are that the language file
  2662.         // won't have populated the language data file, so we can't
  2663.         // risk getting a stylesheet...
  2664.         if ($this->error) {
  2665.             return '';
  2666.         }
  2667.         // First, work out what the selector should be. If there's an ID,
  2668.         // that should be used, the same for a class. Otherwise, a selector
  2669.         // of '' means that these styles will be applied anywhere
  2670.         $selector = ($this->overall_id != '') ? "#{$this->overall_id} " : '';
  2671.         $selector = ($selector == '' && $this->overall_class != '') ? ".{$this->overall_class} " : $selector;
  2672.  
  2673.         // Header of the stylesheet
  2674.         if (!$economy_mode) {
  2675.             $stylesheet = "/**\n * GeSHi Dynamically Generated Stylesheet\n * --------------------------------------\n * Dynamically generated stylesheet for {$this->language}\n * CSS class: {$this->overall_class}, CSS id: {$this->overall_id}\n * GeSHi (C) 2004 - 2007 Nigel McNie (http://qbnz.com/highlighter)\n */\n";
  2676.          } else {
  2677.             $stylesheet = '/* GeSHi (C) 2004 - 2007 Nigel McNie (http://qbnz.com/highlighter) */' . "\n";
  2678.         }
  2679.  
  2680.         // Set the <ol> to have no effect at all if there are line numbers
  2681.         // (<ol>s have margins that should be destroyed so all layout is
  2682.         // controlled by the set_overall_style method, which works on the
  2683.         // <pre> or <div> container). Additionally, set default styles for lines
  2684.         if (!$economy_mode || $this->line_numbers != GESHI_NO_LINE_NUMBERS) {
  2685.             //$stylesheet .= "$selector, {$selector}ol, {$selector}ol li {margin: 0;}\n";
  2686.             $stylesheet .= "$selector.de1, $selector.de2 {{$this->code_style}}\n";
  2687.         }
  2688.  
  2689.         // Add overall styles
  2690.         if (!$economy_mode || $this->overall_style != '') {
  2691.             $stylesheet .= "$selector {{$this->overall_style}}\n";
  2692.         }
  2693.  
  2694.         // Add styles for links
  2695.         foreach ($this->link_styles as $key => $style) {
  2696.             if (!$economy_mode || $key == GESHI_LINK && $style != '') {
  2697.                 $stylesheet .= "{$selector}a:link {{$style}}\n";
  2698.             }
  2699.             if (!$economy_mode || $key == GESHI_HOVER && $style != '') {
  2700.                 $stylesheet .= "{$selector}a:hover {{$style}}\n";
  2701.             }
  2702.             if (!$economy_mode || $key == GESHI_ACTIVE && $style != '') {
  2703.                 $stylesheet .= "{$selector}a:active {{$style}}\n";
  2704.             }
  2705.             if (!$economy_mode || $key == GESHI_VISITED && $style != '') {
  2706.                 $stylesheet .= "{$selector}a:visited {{$style}}\n";
  2707.             }
  2708.         }
  2709.  
  2710.         // Header and footer
  2711.         if (!$economy_mode || $this->header_content_style != '') {
  2712.             $stylesheet .= "$selector.head {{$this->header_content_style}}\n";
  2713.         }
  2714.         if (!$economy_mode || $this->footer_content_style != '') {
  2715.             $stylesheet .= "$selector.foot {{$this->footer_content_style}}\n";
  2716.         }
  2717.  
  2718.         // Styles for important stuff
  2719.         if (!$economy_mode || $this->important_styles != '') {
  2720.             $stylesheet .= "$selector.imp {{$this->important_styles}}\n";
  2721.         }
  2722.  
  2723.         // Styles for lines being highlighted extra
  2724.         if (!$economy_mode || count($this->highlight_extra_lines)) {
  2725.             $stylesheet .= "$selector.ln-xtra {{$this->highlight_extra_lines_style}}\n";
  2726.         }
  2727.  
  2728.         // Simple line number styles
  2729.         if (!$economy_mode || ($this->line_numbers != GESHI_NO_LINE_NUMBERS && $this->line_style1 != '')) {
  2730.             $stylesheet .= "{$selector}li {{$this->line_style1}}\n";
  2731.         }
  2732.  
  2733.         // If there is a style set for fancy line numbers, echo it out
  2734.         if (!$economy_mode || ($this->line_numbers == GESHI_FANCY_LINE_NUMBERS && $this->line_style2 != '')) {
  2735.             $stylesheet .= "{$selector}li.li2 {{$this->line_style2}}\n";
  2736.         }
  2737.  
  2738.         foreach ($this->language_data['STYLES']['KEYWORDS'] as $group => $styles) {
  2739.             if (!$economy_mode || !($economy_mode && (!$this->lexic_permissions['KEYWORDS'][$group] || $styles == ''))) {
  2740.                 $stylesheet .= "$selector.kw$group {{$styles}}\n";
  2741.             }
  2742.         }
  2743.         foreach ($this->language_data['STYLES']['COMMENTS'] as $group => $styles) {
  2744.             if (!$economy_mode || !($economy_mode && $styles == '') &&
  2745.                 !($economy_mode && !$this->lexic_permissions['COMMENTS'][$group])) {
  2746.                 $stylesheet .= "$selector.co$group {{$styles}}\n";
  2747.             }
  2748.         }
  2749.         foreach ($this->language_data['STYLES']['ESCAPE_CHAR'] as $group => $styles) {
  2750.             if (!$economy_mode || !($economy_mode && $styles == '') && !($economy_mode &&
  2751.                 !$this->lexic_permissions['ESCAPE_CHAR'])) {
  2752.                 $stylesheet .= "$selector.es$group {{$styles}}\n";
  2753.             }
  2754.         }
  2755.         foreach ($this->language_data['STYLES']['SYMBOLS'] as $group => $styles) {
  2756.             if (!$economy_mode || !($economy_mode && $styles == '') && !($economy_mode &&
  2757.                 !$this->lexic_permissions['BRACKETS'])) {
  2758.                 $stylesheet .= "$selector.br$group {{$styles}}\n";
  2759.             }
  2760.         }
  2761.         foreach ($this->language_data['STYLES']['STRINGS'] as $group => $styles) {
  2762.             if (!$economy_mode || !($economy_mode && $styles == '') && !($economy_mode &&
  2763.                 !$this->lexic_permissions['STRINGS'])) {
  2764.                 $stylesheet .= "$selector.st$group {{$styles}}\n";
  2765.             }
  2766.         }
  2767.         foreach ($this->language_data['STYLES']['NUMBERS'] as $group => $styles) {
  2768.             if (!$economy_mode || !($economy_mode && $styles == '') && !($economy_mode &&
  2769.                 !$this->lexic_permissions['NUMBERS'])) {
  2770.                 $stylesheet .= "$selector.nu$group {{$styles}}\n";
  2771.             }
  2772.         }
  2773.         foreach ($this->language_data['STYLES']['METHODS'] as $group => $styles) {
  2774.             if (!$economy_mode || !($economy_mode && $styles == '') && !($economy_mode &&
  2775.                 !$this->lexic_permissions['METHODS'])) {
  2776.                 $stylesheet .= "$selector.me$group {{$styles}}\n";
  2777.             }
  2778.         }
  2779.         foreach ($this->language_data['STYLES']['SCRIPT'] as $group => $styles) {
  2780.             if (!$economy_mode || !($economy_mode && $styles == '')) {
  2781.                 $stylesheet .= "$selector.sc$group {{$styles}}\n";
  2782.             }
  2783.         }
  2784.         foreach ($this->language_data['STYLES']['REGEXPS'] as $group => $styles) {
  2785.             if (!$economy_mode || !($economy_mode && $styles == '') && !($economy_mode &&
  2786.                 !$this->lexic_permissions['REGEXPS'][$group])) {
  2787.                 if (is_array($this->language_data['REGEXPS'][$group]) &&
  2788.                          array_key_exists(GESHI_CLASS,
  2789.                                     $this->language_data['REGEXPS'][$group])) {
  2790.                     $stylesheet .= "$selector.";
  2791.                     $stylesheet .= $this->language_data['REGEXPS'][$group][GESHI_CLASS];
  2792.                     $stylesheet .= " {{$styles}}\n";
  2793.                 }
  2794.                 else {
  2795.                     $stylesheet .= "$selector.re$group {{$styles}}\n";
  2796.                 }
  2797.             }
  2798.         }
  2799.  
  2800.         return $stylesheet;
  2801.     }
  2802.  
  2803. } // End Class GeSHi
  2804.  
  2805.  
  2806. if (!function_exists('geshi_highlight')) {
  2807.     /**
  2808.      * Easy way to highlight stuff. Behaves just like highlight_string
  2809.      *
  2810.      * @param string The code to highlight
  2811.      * @param string The language to highlight the code in
  2812.      * @param string The path to the language files. You can leave this blank if you need
  2813.      *               as from version 1.0.7 the path should be automatically detected
  2814.      * @param boolean Whether to return the result or to echo
  2815.      * @return string The code highlighted (if $return is true)
  2816.      * @since 1.0.2
  2817.      */
  2818.     function geshi_highlight($string, $language, $path = null, $return = false) {
  2819.         $geshi = new GeSHi($string, $language, $path);
  2820.         $geshi->set_header_type(GESHI_HEADER_NONE);
  2821.         if ($return) {
  2822.             return '<code>' . $geshi->parse_code() . '</code>';
  2823.         }
  2824.         echo '<code>' . $geshi->parse_code() . '</code>';
  2825.         if ($geshi->error()) {
  2826.             return false;
  2827.         }
  2828.         return true;
  2829.     }
  2830. }
  2831.  
  2832. ?>
  2833.